@veltdev/sdk 3.0.77 → 3.0.79

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

@@ -25,6 +25,7 @@ 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";
+import { CoreEventTypesMap } from "../models/data/core-events.data.model";
 export declare class Snippyly {
   constructor();
   initConfig: (apiKey: string, config?: Config) => void;
@@ -263,4 +264,9 @@ export declare class Snippyly {
     * To get document metadata.
     */
    getDocumentMetadata: () => Observable<DocumentMetadata | null>;
+
+   /**
+    * To subscribe to core actions
+    */
+   on: <T extends keyof CoreEventTypesMap>(action: T) => Observable<CoreEventTypesMap[T]>;
 }

package/app/models/data/button.data.model.d.ts

@@ -0,0 +1,31 @@
+import { CommentAnnotation } from "./comment-annotation.data.model";
+import { Comment } from "./comment.data.model";
+import { VeltEventMetadata } from "./event-metadata.data.model";
+import { Notification } from "./notification.model";
+export interface VeltButtonClickEvent extends VeltButtonData {
+    buttonContext: VeltButtonContext;
+    metadata: VeltEventMetadata;
+}
+export interface VeltButtonContext {
+    type?: string;
+    groupId?: string;
+    selections?: VeltButtonSelectionMap;
+    clickedButtonId?: string;
+}
+export interface VeltButtonData {
+    commentAnnotation?: CommentAnnotation;
+    comment?: Comment;
+    index?: number;
+    commentAnnotations?: CommentAnnotation[];
+    systemFilteredAnnotations?: CommentAnnotation[];
+    unreadCommentAnnotationsMap?: {
+        [commentAnnotationId: string]: number;
+    };
+    notification?: Notification;
+    notifications?: Notification[];
+}
+export interface VeltButtonSelectionMap {
+    [groupId: string]: {
+        [buttonId: string]: boolean;
+    };
+}

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

@@ -1,5 +1,6 @@
 import { CommentAccessMode, CommentEventTypes, CommentStatus } from "../../utils/enums";
 import { Attachment } from "./attachment.model";
+import { VeltButtonClickEvent } from "./button.data.model";
 import { AddAttachmentResponse } from "./comment-actions.data.model";
 import { CommentAnnotation, UpdateContextConfig } from "./comment-annotation.data.model";
 import { Comment } from "./comment.data.model";
@@ -74,6 +75,8 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.ADD_REACTION]: AddReactionEvent;
     [CommentEventTypes.DELETE_REACTION]: DeleteReactionEvent;
     [CommentEventTypes.TOGGLE_REACTION]: ToggleReactionEvent;
+    [CommentEventTypes.COMMENT_SIDEBAR_DATA_INIT]: CommentSidebarDataInitEvent;
+    [CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -222,3 +225,7 @@ export interface CopyLinkEvent {
     link: string;
     metadata: VeltEventMetadata;
 }
+export interface CommentSidebarDataInitEvent extends VeltButtonClickEvent {
+}
+export interface CommentSidebarDataUpdateEvent extends VeltButtonClickEvent {
+}

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

@@ -0,0 +1,5 @@
+import { CoreEventTypes } from "../../utils/enums";
+import { VeltButtonClickEvent } from "./button.data.model";
+export type CoreEventTypesMap = {
+    [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
+};

package/app/utils/enums.d.ts

@@ -39,8 +39,14 @@ export declare const CommentEventTypes: {
     readonly ADD_REACTION: "addReaction";
     readonly DELETE_REACTION: "deleteReaction";
     readonly TOGGLE_REACTION: "toggleReaction";
+    readonly COMMENT_SIDEBAR_DATA_INIT: "commentSidebarDataInit";
+    readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
+};
+export declare const CoreEventTypes: {
+    readonly VELT_BUTTON_CLICK: "veltButtonClick";
 };
 export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
+export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
 export declare enum TagStatus {
     ADDED = "added",
     UPDATED = "updated",

package/models.d.ts

@@ -2,12 +2,14 @@ export * from './app/utils/enums';
 export * from './app/models/data/attachment.model';
 export * from './app/models/data/area-annotation.data.model';
 export * from './app/models/data/base-metadata.data.model';
+export * from './app/models/data/button.data.model';
 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/core-events.data.model';
 export * from './app/models/data/cursor-position.data.model';
 export * from './app/models/data/cursor-user.data.model';
 export * from './app/models/data/custom-css.data.model';

package/package.json

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