@veltdev/sdk 3.0.69 → 3.0.70

package/app/client/snippyly.model.d.ts

@@ -24,6 +24,7 @@ import { FeatureType } from "../utils/enums";
 import { UserContact } from "../models/data/user-contact.data.model";
 import { DocumentMetadata } from "../models/data/document-metadata.model";
 import { ReactionElement } from "../models/element/reaction-element.model";
+import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
 export declare class Snippyly {
   constructor();
   initConfig: (apiKey: string, config?: Config) => void;
@@ -162,6 +163,10 @@ export declare class Snippyly {
    * Get the Area Object.
    */
   getReactionElement: () => ReactionElement;
+  /**
+   * Get the metadata of the current resource.
+   */
+  getMetadata: () => Promise<VeltEventMetadata | null>;
   /**
    * To signout a user
    */

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

@@ -4,139 +4,153 @@ 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 { UserContact } from "./user-contact.data.model";
 import { User } from "./user.data.model";
-export declare class ActionOptions {
+export interface RequestOptions {
     organizationId?: string;
     documentId?: string;
 }
-export declare class UpdatePriorityConfig {
+export interface UpdatePriorityRequest {
     annotationId: string;
     priority?: CustomPriority;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class UpdateStatusConfig {
+export interface UpdateStatusRequest {
     annotationId: string;
     status: CustomStatus;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class UpdateAccessConfig {
+export interface UpdateAccessRequest {
     annotationId: string;
     accessMode: CommentAccessMode;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class ResolveCommentAnnotationConfig {
+export interface ResolveCommentAnnotationRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class GetLinkConfig {
+export interface GetLinkRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class CopyLinkConfig {
+export interface CopyLinkRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class AddCommentAnnotationConfig {
+export interface AddCommentAnnotationRequest {
     annotation: CommentAnnotation;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class ApproveCommentAnnotationConfig {
+export interface ApproveCommentAnnotationRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class AcceptCommentAnnotationConfig {
+export interface AcceptCommentAnnotationRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class RejectCommentAnnotationConfig {
+export interface RejectCommentAnnotationRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class DeleteCommentAnnotationConfig {
+export interface DeleteCommentAnnotationRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class AddCommentConfig {
+export interface SubscribeCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface UnsubscribeCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface AssignUserRequest {
+    annotationId: string;
+    assignedTo: UserContact;
+    options?: RequestOptions;
+}
+export interface AddCommentRequest {
     annotationId: string;
     comment: Comment;
     assignedTo?: User;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class UpdateCommentConfig {
+export interface UpdateCommentRequest {
     annotationId: string;
     comment: Comment;
     skipDeleteThreadConfirmation?: boolean;
     merge?: boolean;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class DeleteCommentConfig {
+export interface DeleteCommentRequest {
     annotationId: string;
     commentId: number;
     skipDeleteThreadConfirmation?: boolean;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class GetCommentConfig {
+export interface GetCommentRequest {
     annotationId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class AddAttachmentConfig {
+export interface AddAttachmentRequest {
     annotationId: string;
     files: File[];
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class AddAttachmentResponse {
+export interface AddAttachmentResponse {
     valid: boolean;
     file?: File;
     maxAllowedSize: number;
     error?: string;
     attachment?: Attachment;
 }
-export declare class DeleteAttachmentConfig {
+export interface DeleteAttachmentRequest {
     annotationId: string;
     commentId: number;
     attachmentId: number;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class GetAttachmentConfig {
+export interface GetAttachmentRequest {
     annotationId: string;
     commentId: number;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class GetRecordingConfig {
+export interface GetRecordingRequest {
     annotationId: string;
     commentId: number;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class DeleteRecordingConfig {
+export interface DeleteRecordingRequest {
     annotationId: string;
     commentId: number;
     recorderId: string;
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class AddReactionConfig {
+export interface AddReactionRequest {
     annotationId: string;
     commentId: number;
     reaction: {
         reactionId: string;
         customReaction?: ReactionItem;
     };
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class DeleteReactionConfig {
+export interface DeleteReactionRequest {
     annotationId: string;
     commentId: number;
     reaction: {
         reactionId: string;
         customReaction?: ReactionItem;
     };
-    options?: ActionOptions;
+    options?: RequestOptions;
 }
-export declare class ToggleReactionConfig {
+export interface ToggleReactionRequest {
     annotationId: string;
     commentId: number;
     reaction: {
         reactionId: string;
         customReaction?: ReactionItem;
     };
-    options?: ActionOptions;
+    options?: RequestOptions;
 }

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

@@ -1,15 +1,18 @@
-import { CommentAccessMode, CommentStatus } from "../../utils/enums";
+import { CommentAccessMode, CommentEventTypes, 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 { VeltEventMetadata } from "./event-metadata.data.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 { UserContact } from "./user-contact.data.model";
 import { User } from "./user.data.model";
+/**
+ * @deprecated Use `AddCommentAnnotationEvent` instead
+ */
 export interface CommentAddEventData {
     annotation: CommentAnnotation;
     location?: Location;
@@ -21,6 +24,9 @@ export interface CommentAddEventData {
         xpath: string;
     };
 }
+/**
+ * @deprecated Use respective events instead
+ */
 export interface CommentEvent {
     annotation?: CommentAnnotation | null;
     element?: HTMLElement;
@@ -29,8 +35,14 @@ export interface CommentEvent {
     targetCommentId?: number;
     updateContext?: (context: any, config?: UpdateContextConfig) => void;
 }
+/**
+ * @deprecated Use respective events instead
+ */
 export interface CommentUpdateEventData extends CommentEvent {
 }
+/**
+ * @deprecated Use `AcceptCommentAnnotationEvent` and `RejectCommentAnnotationEvent` instead
+ */
 export interface CommentSuggestionEventData {
     annotationId: string;
     actionUser?: User;
@@ -39,83 +51,128 @@ export interface CommentSuggestionEventData {
     replaceContentText?: string;
     annotation?: any;
 }
-export interface CommentEventMetadata {
-    organizationMetadata?: OrganizationMetadata | null;
-    documentMetadata?: DocumentMetadata | null;
-    location?: Location | null;
-}
+export type CommentEventTypesMap = {
+    [CommentEventTypes.ADD_COMMENT_ANNOTATION]: AddCommentAnnotationEvent;
+    [CommentEventTypes.APPROVE_COMMENT_ANNOTATION]: ApproveCommentAnnotationEvent;
+    [CommentEventTypes.ACCEPT_COMMENT_ANNOTATION]: AcceptCommentAnnotationEvent;
+    [CommentEventTypes.REJECT_COMMENT_ANNOTATION]: RejectCommentAnnotationEvent;
+    [CommentEventTypes.SUBSCRIBE_COMMENT_ANNOTATION]: SubscribeCommentAnnotationEvent;
+    [CommentEventTypes.UNSUBSCRIBE_COMMENT_ANNOTATION]: UnsubscribeCommentAnnotationEvent;
+    [CommentEventTypes.DELETE_COMMENT_ANNOTATION]: DeleteCommentAnnotationEvent;
+    [CommentEventTypes.ASSIGN_USER]: AssignUserEvent;
+    [CommentEventTypes.UPDATE_PRIORITY]: UpdatePriorityEvent;
+    [CommentEventTypes.UPDATE_STATUS]: UpdateStatusEvent;
+    [CommentEventTypes.UPDATE_ACCESS]: UpdateAccessEvent;
+    [CommentEventTypes.RESOLVE_COMMENT]: ResolveCommentEvent;
+    [CommentEventTypes.ADD_COMMENT]: AddCommentEvent;
+    [CommentEventTypes.UPDATE_COMMENT]: UpdateCommentEvent;
+    [CommentEventTypes.DELETE_COMMENT]: DeleteCommentEvent;
+    [CommentEventTypes.ADD_ATTACHMENT]: AddAttachmentEvent;
+    [CommentEventTypes.DELETE_ATTACHMENT]: DeleteAttachmentEvent;
+    [CommentEventTypes.DELETE_RECORDING]: DeleteRecordingEvent;
+    [CommentEventTypes.COPY_LINK]: CopyLinkEvent;
+    [CommentEventTypes.ADD_REACTION]: AddReactionEvent;
+    [CommentEventTypes.DELETE_REACTION]: DeleteReactionEvent;
+    [CommentEventTypes.TOGGLE_REACTION]: ToggleReactionEvent;
+};
 export interface AddAttachmentEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
     attachments: AddAttachmentResponse[];
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface DeleteAttachmentEvent {
-    annotationId?: string;
-    commentId?: number;
-    commentAnnotation?: CommentAnnotation;
+    annotationId: string;
+    commentId: number;
+    commentAnnotation: CommentAnnotation;
     attachment: Attachment;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface AddCommentAnnotationEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    metadata: CommentEventMetadata;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+    addContext: (context: any) => void;
+    elementRef?: {
+        xpath: string;
+    };
 }
 export interface ApproveCommentAnnotationEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    metadata: CommentEventMetadata;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
 }
 export interface AcceptCommentAnnotationEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    metadata: CommentEventMetadata;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+    actionUser: User;
+    replaceContentHtml?: string;
+    replaceContentText?: string;
 }
 export interface RejectCommentAnnotationEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    metadata: CommentEventMetadata;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+    actionUser: User;
+    replaceContentHtml?: string;
+    replaceContentText?: string;
 }
 export interface DeleteCommentAnnotationEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    metadata: CommentEventMetadata;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+}
+export interface SubscribeCommentAnnotationEvent {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+}
+export interface UnsubscribeCommentAnnotationEvent {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+}
+export interface AssignUserEvent {
+    annotationId: string;
+    assignedTo: UserContact;
+    commentAnnotation: CommentAnnotation;
+    metadata?: VeltEventMetadata;
 }
 export interface AddCommentEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    commentId?: number;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    commentId: number;
     comment: Comment;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface UpdateCommentEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    commentId?: number;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    commentId: number;
     comment: Comment;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface DeleteCommentEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    commentId?: number;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    commentId: number;
     comment: Comment;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface DeleteRecordingEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    commentId?: number;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    commentId: number;
     recording: RecordedData;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface ReactionEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
-    commentId?: number;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    commentId: number;
     reaction: ReactionAnnotation;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface AddReactionEvent extends ReactionEvent {
 }
@@ -124,35 +181,40 @@ export interface DeleteReactionEvent extends ReactionEvent {
 export interface ToggleReactionEvent extends ReactionEvent {
 }
 export interface UpdateStatusEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
     newStatus: CustomStatus;
     oldStatus: CustomStatus;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface UpdatePriorityEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
     newPriority?: CustomPriority;
     oldPriority?: CustomPriority;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface UpdateAccessEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
     newAccessMode?: CommentAccessMode;
     oldAccessMode?: CommentAccessMode;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
-export interface GetLinkEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
+export interface ResolveCommentEvent {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+}
+export interface GetLinkResponse {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
     link: string | null;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }
 export interface CopyLinkEvent {
-    annotationId?: string;
-    commentAnnotation?: CommentAnnotation;
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
     link: string;
-    metadata: CommentEventMetadata;
+    metadata: VeltEventMetadata;
 }

package/app/models/data/event-metadata.data.model.d.ts

@@ -0,0 +1,8 @@
+import { DocumentMetadata } from "./document-metadata.model";
+import { Location } from "./location.model";
+import { OrganizationMetadata } from "./organization-metadata.model";
+export interface VeltEventMetadata {
+    organizationMetadata?: OrganizationMetadata | null;
+    documentMetadata?: DocumentMetadata | null;
+    location?: Location | null;
+}