@veltdev/sdk-staging 5.0.2-beta.1 → 5.0.2-beta.10

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

@@ -29,7 +29,7 @@ import { VeltEventMetadata, VeltDebugInfo } from "../models/data/event-metadata.
 import { CoreEventTypesMap } from "../models/data/core-events.data.model";
 import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } from "../models/data/document.data.model";
 import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
-import { UserDataProvider, GetUserPermissionsRequest, GetUserPermissionsResponse } from "../models/data/user-resolver.data.model";
+import { AnonymousUserDataProvider, UserDataProvider, GetUserPermissionsRequest, GetUserPermissionsResponse } from "../models/data/user-resolver.data.model";
 import { VeltDataProvider } from "../models/data/provider.data.model";
 import { VeltEncryptionProvider } from "../models/data/encryption-provider.data.model";
 import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
@@ -97,6 +97,10 @@ export declare class Snippyly {
     * To set the user data provider.
     */
    setUserDataProvider: (userDataProvider: UserDataProvider) => void;
+   /**
+    * To set the anonymous user data provider.
+    */
+   setAnonymousUserDataProvider: (resolver: AnonymousUserDataProvider, config?: { ha?: boolean }) => void;
    /**
     * To set the data provider.
     */

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

@@ -141,6 +141,8 @@ export interface AddCommentRequest {
     assignedTo?: User;
     assigned?: boolean;
     options?: RequestOptions;
+    /** Optional visibility configuration for the comment */
+    visibility?: CommentVisibilityConfig;
 }
 export interface UpdateCommentRequest {
     annotationId: string;

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

@@ -1,5 +1,6 @@
-import { CommentAccessMode } from "../../utils/enums";
+import { CommentAccessMode, CommentVisibilityOptionType } from "../../utils/enums";
 import { BaseMetadata } from "./base-metadata.data.model";
+import { CommentVisibilityType } from "./comment-actions.data.model";
 import { Comment } from "./comment.data.model";
 import { CursorPosition } from "./cursor-position.data.model";
 import { CustomAnnotationDropdownItem } from "./custom-chip-dropdown.data.model";
@@ -10,6 +11,11 @@ import { TargetElement } from "./target-element.data.model";
 import { TargetTextRange } from "./target-text-range.data.model";
 import { User } from "./user.data.model";
 import { CommentAnnotationViews } from "./views.data.model";
+export interface CommentAnnotationVisibilityConfig {
+    type: CommentVisibilityType;
+    organizationId?: string;
+    userIds?: string[];
+}
 export declare class CommentAnnotation {
     /**
      * Unique identifier for the comment pin annotation.
@@ -23,6 +29,7 @@ export declare class CommentAnnotation {
      * Auto generated.
      */
     annotationNumber?: number;
+    visibilityConfig?: CommentAnnotationVisibilityConfig;
     /**
      * This is the list of all comments part of this annotation.
      *
@@ -232,6 +239,11 @@ export declare class CommentSelectionChangeData {
     selected: boolean;
     annotation: CommentAnnotation;
 }
+export declare class VisibilityOptionClickedData {
+    annotationId: string;
+    visibility: CommentVisibilityOptionType;
+    users?: any[];
+}
 export declare class InlineCommentSectionConfig {
     id: string;
     name?: string;

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

@@ -1,4 +1,4 @@
-import { AssignToType, CommentAccessMode, CommentEventTypes, CommentStatus } from "../../utils/enums";
+import { AssignToType, CommentAccessMode, CommentEventTypes, CommentStatus, CommentVisibilityOptionType } from "../../utils/enums";
 import { Attachment } from "./attachment.model";
 import { VeltButtonClickEvent } from "./button.data.model";
 import { AddAttachmentResponse } from "./comment-actions.data.model";
@@ -85,9 +85,13 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
     [CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
     [CommentEventTypes.COMMENT_TOOL_CLICK]: CommentToolClickEvent;
+    [CommentEventTypes.COMMENT_TOOL_CLICKED]: CommentToolClickedEvent;
     [CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
+    [CommentEventTypes.SIDEBAR_BUTTON_CLICKED]: SidebarButtonClickedEvent;
     [CommentEventTypes.ATTACHMENT_DOWNLOAD_CLICKED]: AttachmentDownloadClickedEvent;
     [CommentEventTypes.COMMENT_SAVED]: CommentSavedEvent;
+    [CommentEventTypes.COMMENT_SAVE_TRIGGERED]: CommentSaveTriggeredEvent;
+    [CommentEventTypes.VISIBILITY_OPTION_CLICKED]: VisibilityOptionClickedEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -182,6 +186,11 @@ export interface CommentSavedEvent {
     commentAnnotation: CommentAnnotation;
     metadata: VeltEventMetadata;
 }
+export interface CommentSaveTriggeredEvent {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+}
 export interface UpdateCommentEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;
@@ -308,12 +317,23 @@ export interface CommentToolClickEvent {
     targetElementId?: string | null;
     metadata?: VeltEventMetadata;
 }
+export interface CommentToolClickedEvent extends CommentToolClickEvent {
+}
 export interface SidebarButtonClickEvent {
     metadata?: VeltEventMetadata;
 }
+export interface SidebarButtonClickedEvent extends SidebarButtonClickEvent {
+}
 export interface AttachmentDownloadClickedEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;
     attachment: Attachment;
     metadata?: VeltEventMetadata;
 }
+export interface VisibilityOptionClickedEvent {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    visibility: CommentVisibilityOptionType;
+    users?: any[];
+    metadata?: VeltEventMetadata;
+}

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

@@ -23,7 +23,8 @@ export declare enum UserResolverSource {
     SET_SINGLE_EDITOR_MODE_LIVE_STATE_DATA_FOR_DIFFERENT_USER_PRESENT_ON_TAB = "setSingleEditorModeLiveStateDataForDifferentUserPresentOnTab",
     RESOLVE_AND_MERGE_SINGLE_EDITOR_LIVE_STATE_DATA_WITH_USER = "resolveAndMergeSingleEditorLiveStateDataWithUser",
     GET_SINGLE_EDITOR_MODE_DATA = "getSingleEditorModeData",
-    RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages"
+    RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages",
+    RESOLVE_USER_IDS_BY_EMAIL = "resolveUserIdsByEmail"
 }
 export declare enum UserResolverModuleName {
     IDENTIFY = "identify/authProvider",

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

@@ -1,10 +1,11 @@
 import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
 import { AttachmentDataProvider } from "./attachment-resolver.data.model";
 import { ReactionAnnotationDataProvider } from "./reaction-resolver.data.model";
-import { UserDataProvider } from "./user-resolver.data.model";
+import { AnonymousUserDataProvider, UserDataProvider } from "./user-resolver.data.model";
 export interface VeltDataProvider {
     comment?: CommentAnnotationDataProvider;
     user?: UserDataProvider;
     reaction?: ReactionAnnotationDataProvider;
     attachment?: AttachmentDataProvider;
+    anonymousUser?: AnonymousUserDataProvider;
 }

package/app/models/data/user-resolver.data.model.d.ts

@@ -1,10 +1,24 @@
-import { ResolverConfig } from "./resolver.data.model";
+import { ResolverConfig, ResolverResponse, RetryConfig } from "./resolver.data.model";
 import { User } from "./user.data.model";
 export interface UserDataProvider {
     get(userIds: string[]): Promise<Record<string, User>>;
     config?: ResolverConfig;
     resolveTimeout?: number;
 }
+export interface AnonymousUserDataProvider {
+    resolveUserIdsByEmail(request: ResolveUserIdsByEmailRequest): Promise<ResolverResponse<Record<string, string>>>;
+    config?: AnonymousUserDataProviderConfig;
+}
+export interface AnonymousUserDataProviderConfig {
+    resolveTimeout?: number;
+    getRetryConfig?: RetryConfig;
+}
+export interface ResolveUserIdsByEmailRequest {
+    organizationId: string;
+    documentId?: string;
+    folderId?: string;
+    emails: string[];
+}
 export interface GetUserResolverRequest {
     organizationId: string;
     userIds: string[];

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

@@ -290,6 +290,16 @@ export declare class CommentElement {
    */
   public disableStatus: () => any;
 
+  /**
+   * To enable visibility options on comments
+   */
+  public enableVisibilityOptions: () => any;
+
+  /**
+   * To disable visibility options on comments
+   */
+  public disableVisibilityOptions: () => any;
+
   /**
    * To enable feature to show resolve button
    */
@@ -1615,6 +1625,16 @@ export declare class CommentElement {
    */
   private _disableStatus;
 
+  /**
+   * To enable visibility options on comments
+   */
+  private _enableVisibilityOptions;
+
+  /**
+   * To disable visibility options on comments
+   */
+  private _disableVisibilityOptions;
+
   /**
    * To enable feature to show resolve button
    */

package/app/utils/enums.d.ts

@@ -60,9 +60,13 @@ export declare const CommentEventTypes: {
     readonly COMMENT_PIN_CLICKED: "commentPinClicked";
     readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
     readonly COMMENT_TOOL_CLICK: "commentToolClick";
+    readonly COMMENT_TOOL_CLICKED: "commentToolClicked";
     readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
+    readonly SIDEBAR_BUTTON_CLICKED: "sidebarButtonClicked";
     readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
     readonly COMMENT_SAVED: "commentSaved";
+    readonly COMMENT_SAVE_TRIGGERED: "commentSaveTriggered";
+    readonly VISIBILITY_OPTION_CLICKED: "visibilityOptionClicked";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";
@@ -309,3 +313,7 @@ export type NotificationSettingsItemType = 'ALL' | 'MINE' | 'NONE' | string;
  * Type for notification settings layout
  */
 export type NotificationSettingsLayout = 'accordion' | 'dropdown';
+/**
+ * Type for comment visibility options in the visibility banner dropdown
+ */
+export type CommentVisibilityOptionType = 'personal' | 'selected-people' | 'org-users' | 'public';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-staging",
-    "version": "5.0.2-beta.1",
+    "version": "5.0.2-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": [