@veltdev/sdk 4.7.6 → 5.0.0-beta.10

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

@@ -41,9 +41,29 @@ export interface CopyLinkRequest {
     annotationId: string;
     options?: RequestOptions;
 }
+/**
+ * Visibility type for comment annotations.
+ * - 'public': Visible to everyone (default:velt)
+ * - 'organization': Visible only to users in the specified organization
+ * - 'self': Visible only to specified users (private comments)
+ */
+export type CommentVisibilityType = 'public' | 'organization' | 'self';
+/**
+ * Configuration for comment visibility/access control.
+ */
+export interface CommentVisibilityConfig {
+    /** The type of visibility for the comment */
+    type: CommentVisibilityType;
+    /** Organization ID for 'organization' type visibility */
+    organizationId?: string;
+    /** User IDs for 'self' type visibility - array of user IDs who can see the comment */
+    userIds?: string[];
+}
 export interface AddCommentAnnotationRequest {
     annotation: CommentAnnotation;
     options?: RequestOptions;
+    /** Optional visibility configuration for the comment */
+    visibility?: CommentVisibilityConfig;
 }
 export interface ApproveCommentAnnotationRequest {
     annotationId: string;
@@ -210,12 +230,3 @@ export interface FetchCommentAnnotationsRequest {
     userIds?: string[];
     mentionedUserIds?: string[];
 }
-export interface SubmitCommentRequest {
-    targetComposerElementId: string;
-}
-export interface ClearComposerRequest {
-    targetComposerElementId: string;
-}
-export interface GetComposerDataRequest {
-    targetComposerElementId: string;
-}

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

@@ -54,6 +54,7 @@ export interface CommentSuggestionEventData {
 }
 export type CommentEventTypesMap = {
     [CommentEventTypes.ADD_COMMENT_ANNOTATION]: AddCommentAnnotationEvent;
+    [CommentEventTypes.ADD_COMMENT_ANNOTATION_DRAFT]: AddCommentAnnotationDraftEvent;
     [CommentEventTypes.APPROVE_COMMENT_ANNOTATION]: ApproveCommentAnnotationEvent;
     [CommentEventTypes.ACCEPT_COMMENT_ANNOTATION]: AcceptCommentAnnotationEvent;
     [CommentEventTypes.REJECT_COMMENT_ANNOTATION]: RejectCommentAnnotationEvent;
@@ -79,10 +80,10 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
     [CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
     [CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
+    [CommentEventTypes.COMPOSER_TEXT_CHANGE]: ComposerTextChangeEvent;
     [CommentEventTypes.LINK_CLICKED]: LinkClickedEvent;
     [CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
     [CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
-    [CommentEventTypes.COMPOSER_TEXT_CHANGE]: ComposerTextChangeEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -97,6 +98,10 @@ export interface DeleteAttachmentEvent {
     attachment: Attachment;
     metadata: VeltEventMetadata;
 }
+export interface AddCommentAnnotationDraftEvent {
+    metadata: VeltEventMetadata;
+    addContext: (context: Record<string, unknown>) => void;
+}
 export interface AddCommentAnnotationEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;
@@ -273,7 +278,5 @@ export interface CommentBubbleClickedEvent {
 }
 export interface ComposerTextChangeEvent {
     text: string;
-    annotation: CommentAnnotation;
-    targetComposerElementId: string;
     metadata?: VeltEventMetadata;
 }

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

@@ -1,3 +1,4 @@
+import { Location } from './location.model';
 export interface IUnreadCommentsMap {
     [annotationId: string]: number;
 }
@@ -14,3 +15,28 @@ export interface TransformContext {
         inverseScale?: number;
     };
 }
+/**
+ * Context data returned by the comment context provider.
+ * This is a flexible object that can contain custom properties.
+ */
+export interface CommentContext {
+    /**
+     * Optional comment type. When set to 'manual', the comment will be treated as a manual comment
+     * and the target element will be removed.
+     */
+    commentType?: 'manual' | string;
+    /**
+     * Allow additional custom properties
+     */
+    [key: string]: unknown;
+}
+export type CommentContextProviderResponse = CommentContext | null | undefined;
+/**
+ * A function that provides custom context for comments.
+ * Can return the context synchronously or asynchronously via a Promise.
+ *
+ * @param documentId - The ID of the document
+ * @param location - Optional location information
+ * @returns The comment context object or a Promise that resolves to it
+ */
+export type CommentContextProvider = (documentId: string, location?: Location) => CommentContextProviderResponse | Promise<CommentContextProviderResponse>;

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

@@ -53,6 +53,14 @@ export declare class Config {
      * The domain of the API proxy.
      */
     apiProxyDomain?: string;
+    /**
+     * Controls whether global Velt styles are loaded.
+     * When true (default), global styles are applied.
+     * When false, global styles are not loaded - useful for custom styling.
+     *
+     * Default: true
+     */
+    globalStyles?: boolean;
 }
 export interface ExtendedFirebaseOptions extends FirebaseOptions {
     storeDbId: string;

package/app/models/data/custom-filter.data.model.d.ts

@@ -6,6 +6,8 @@ export interface CustomFilter {
 }
 export interface CustomPriority extends CustomFilter {
     lightColor?: string;
+    svg?: string;
+    iconUrl?: string;
 }
 export interface CustomStatus extends CustomFilter {
     type: StatusType;

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

@@ -1,16 +1,16 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
-import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, ComposerTextChangeEvent, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, 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 { CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
+import { UploadFileData } from "../data/attachment.model";
 import { AutocompleteData } from "../data/autocomplete.data.model";
+import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserEvent, AssignUserRequest, CommentRequestQuery, CommentVisibilityConfig, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, ToggleReactionRequest, UnsubscribeCommentAnnotationRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
+import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
+import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
+import { CommentContextProvider, TransformContext, UnreadCommentsCount } from "../data/comment-utils.data.model";
+import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
+import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
-import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, ClearComposerRequest, CommentRequestQuery, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, GetAttachmentRequest, GetCommentRequest, GetComposerDataRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubmitCommentRequest, SubscribeCommentAnnotationRequest, ToggleReactionRequest, UnsubscribeCommentAnnotationRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
-import { UnreadCommentsCount, TransformContext } from "../data/comment-utils.data.model";
-import { AssignToType, CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
-import { UploadFileData } from "../data/attachment.model";
 
 export declare class CommentElement {
   /**
@@ -85,28 +85,6 @@ export declare class CommentElement {
    */
   toggleCommentSidebar: () => any;
 
-  /**
-   * To enable context in page mode composer feature
-   * When enabled, clicking comment tool will open sidebar with page mode composer and pass context
-   */
-  enableContextInPageModeComposer: () => void;
-
-  /**
-   * To disable context in page mode composer feature
-   */
-  disableContextInPageModeComposer: () => void;
-
-  /**
-   * To clear page mode composer context
-   */
-  clearPageModeComposerContext: () => void;
-
-  /**
-   * To set assign to type for comment dialog
-   * @param type 'dropdown' | 'checkbox'
-   */
-  setAssignToType: (type: AssignToType) => void;
-
   /**
   * To enable moderator mode
   */
@@ -351,7 +329,7 @@ export declare class CommentElement {
    * @description Sets the comment context provider
    * @param provider
    */
-  public setContextProvider: (provider: (documentId: string, location?: any) => any) => void;
+  public setContextProvider: (provider: CommentContextProvider | null) => void;
 
   /**
    * To enable suggestion mode
@@ -845,6 +823,14 @@ export declare class CommentElement {
    */
   public updateContext: (annotationId: string, context: any, config?: UpdateContextConfig) => Promise<any>;
 
+  /**
+   * Updates the visibility of a comment annotation.
+   * @param annotationId Annotation Id
+   * @param visibility Visibility configuration (public, organization, or self)
+   * @returns Promise<any>
+   */
+  public updateVisibility: (annotationId: string, visibility: CommentVisibilityConfig) => Promise<any>;
+
   /**
    * Subscribe to selected comments
    * @returns list of selected comments
@@ -1286,6 +1272,13 @@ export declare class CommentElement {
    */
   public disableScreenshot: () => void;
 
+  /**
+   * To programmatically submit a comment from a velt-comment-composer.
+   * Finds the composer within the element identified by referenceId and submits its content.
+   * @param referenceId The ID of the HTML element containing the velt-comment-composer
+   */
+  public submitComment: (referenceId: string) => void;
+
   /**
    * To enable paginated contact list
    */
@@ -1296,26 +1289,6 @@ export declare class CommentElement {
    */
   public disablePaginatedContactList: () => void;
 
-  /**
-   * Programmatically trigger comment submission for a composer with the given targetComposerElementId
-   * @param request SubmitCommentRequest containing targetComposerElementId
-   */
-  public submitComment: (request: SubmitCommentRequest) => void;
-
-  /**
-   * Programmatically clear the composer state for the given targetComposerElementId
-   * @param request ClearComposerRequest containing targetComposerElementId
-   */
-  public clearComposer: (request: ClearComposerRequest) => void;
-
-  /**
-   * Get the current composer data for a given targetComposerElementId
-   * Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
-   * @param request GetComposerDataRequest containing targetComposerElementId
-   * @returns The composer data or null if not found
-   */
-  public getComposerData: (request: GetComposerDataRequest) => ComposerTextChangeEvent | null;
-
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -2117,6 +2090,14 @@ export declare class CommentElement {
    */
   private _updateContext;
 
+  /**
+   * Updates the visibility of a comment annotation.
+   * @param annotationId Annotation Id
+   * @param visibility Visibility configuration (public, organization, or self)
+   * @returns Promise<any>
+   */
+  private _updateVisibility;
+
   /**
    * Subscribe to selected comments
    * @returns list of selected comments
@@ -2570,43 +2551,9 @@ export declare class CommentElement {
   private _disablePaginatedContactList;
 
   /**
-   * Programmatically trigger comment submission for a composer with the given targetComposerElementId
-   * @param request SubmitCommentRequest containing targetComposerElementId
+   * To programmatically submit a comment from a velt-comment-composer.
+   * Finds the composer within the element identified by referenceId and submits its content.
+   * @param referenceId The ID of the HTML element containing the velt-comment-composer
    */
   private _submitComment;
-
-  /**
-   * Programmatically clear the composer state for the given targetComposerElementId
-   * @param request ClearComposerRequest containing targetComposerElementId
-   */
-  private _clearComposer;
-
-  /**
-   * Get the current composer data for a given targetComposerElementId
-   * Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
-   * @param request GetComposerDataRequest containing targetComposerElementId
-   * @returns The composer data or null if not found
-   */
-  private _getComposerData;
-
-  /**
-   * To enable context in page mode composer feature
-   */
-  private _enableContextInPageModeComposer;
-
-  /**
-   * To disable context in page mode composer feature
-   */
-  private _disableContextInPageModeComposer;
-
-  /**
-   * To clear page mode composer context
-   */
-  private _clearPageModeComposerContext;
-
-  /**
-   * To set assign to type for comment dialog
-   * @param type 'dropdown' | 'checkbox'
-   */
-  private _setAssignToType;
 }

package/app/utils/constants.d.ts

@@ -11,6 +11,7 @@ export declare class Constants {
     static LISTENER_BATCH_SIZE: number;
     static LISTENER_CONTEXT_BATCH_SIZE: number;
     static DEFAULT_VELT_CONTEXT: string;
+    static VISIBILITY_SELF_PREFIX: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
     static FIREBASE_PARTIAL_PATH_FOLDERS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;
@@ -244,16 +245,6 @@ export declare class Constants {
         VELT_WIREFRAME: string;
         VELT_AUTOCOMPLETE: string;
         VELT_AUTOCOMPLETE_CHIP: string;
-        VELT_COMMENT_DIALOG_HEADER: string;
-        VELT_COMMENT_DIALOG_BODY: string;
-        VELT_COMMENT_DIALOG_FOOTER: string;
-        VELT_COMMENT_DIALOG_PRIORITY: string;
-        VELT_COMMENT_DIALOG_STATUS: string;
-        VELT_COMMENT_DIALOG_COPY_LINK: string;
-        VELT_COMMENT_DIALOG_RESOLVE_BUTTON: string;
-        VELT_COMMENT_DIALOG_OPTIONS: string;
-        VELT_COMMENT_DIALOG_BODY_THREAD_CARD: string;
-        VELT_COMMENT_DIALOG_PRIVATE_BANNER: string;
         VELT_COMMENT_COMPOSER: string;
         VELT_SKELETON_LOADER: string;
         VELT_SHADOW_DOM_INTERNAL: string;

package/app/utils/enums.d.ts

@@ -29,6 +29,7 @@ export declare enum ResolverActions {
 }
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
+    readonly ADD_COMMENT_ANNOTATION_DRAFT: "addCommentAnnotationDraft";
     readonly DELETE_COMMENT_ANNOTATION: "deleteCommentAnnotation";
     readonly APPROVE_COMMENT_ANNOTATION: "approveCommentAnnotation";
     readonly ACCEPT_COMMENT_ANNOTATION: "acceptCommentAnnotation";
@@ -54,10 +55,10 @@ export declare const CommentEventTypes: {
     readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
     readonly AUTOCOMPLETE_SEARCH: "autocompleteSearch";
     readonly COMPOSER_CLICKED: "composerClicked";
+    readonly COMPOSER_TEXT_CHANGE: "composerTextChange";
     readonly LINK_CLICKED: "linkClicked";
     readonly COMMENT_PIN_CLICKED: "commentPinClicked";
     readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
-    readonly COMPOSER_TEXT_CHANGE: "composerTextChange";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";
@@ -186,7 +187,6 @@ export declare enum AnalyticsFeatures {
     COMMENT_SIDEBAR = "commentSidebar"
 }
 export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
-export type AssignToType = 'dropdown' | 'checkbox';
 export declare enum DeviceType {
     DESKTOP = "Desktop",
     MOBILE = "Mobile",
@@ -279,10 +279,10 @@ export type OverlayOriginY = 'top' | 'center' | 'bottom';
 export type OverlayOriginX = 'start' | 'center' | 'end';
 export type SubtitlesMode = 'floating' | 'embed';
 export type RecorderVariant = 'default' | 'embed';
-export type ReactionPinType = 'timeline' | 'comment' | 'standalone';
+export type ReactionPinType = 'timeline' | 'comment';
 export type SidebarPosition = 'left' | 'right';
 export type SidebarSortingCriteria = 'date' | 'unread' | null;
-export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | 'assignedToMe' | 'reset' | null;
+export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | 'reset' | null;
 export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'involved' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions' | string;
 export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
 export type NotificationPanelMode = 'popover' | 'sidebar';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "4.7.6",
+    "version": "5.0.0-beta.10",
     "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": [
@@ -36,7 +36,7 @@
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
         "version:update": "node ../update-npm-package.mjs",
-        "publish:sdk": "npm publish --access public --tag v4-7-6"
+        "publish:sdk": "npm publish --access public"
     },
     "author": "",
     "license": "ISC",