@veltdev/types-dev 4.0.20 → 4.1.0

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

@@ -26,210 +26,214 @@ 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";
-import { Document, SetDocumentsRequestOptions } from "../models/data/document.data.model";
+import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest } from "../models/data/document.data.model";
+import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
+import { UserDataProvider } from "../models/data/user-resolver.data.model";
+
 export declare class Snippyly {
-  constructor();
-  initConfig: (apiKey: string, config?: Config) => void;
-  identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
-  /**
-   * Tell us who the currently logged in user is.
-   *
-   * Call whenever the user is updated: signs in, signs out, signs up etc.
-   * @deprecated This method is deprecated and will be removed in next release.
-   */
-  updateUser: (user: User) => void;
-  /**
-   * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
-   * @param id unique document ID
-   * @param documentMetadata Document Metadata
-   */
-  setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
-  /**
-   * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
-   * @param id unique document ID
-   */
-  setDocumentId: (id: string) => void;
-  /**
-   * To set multiple documents
-   */
-  setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
-  /**
-   * To unset the document id
-   */
-  unsetDocumentId: () => void;
-  /**
-   * Get Document ID
-   */
-  getDocumentId: () => string;
-  /**
-   * Tell us the custom params of the current document/resource to identify sub document inside a document.
-   * @param params Document Params
-   * @deprecated This method is depercated and will be removed in next release. Use `setLocation` method instead.
-   */
-  setDocumentParams: (params: Location) => void;
-  /**
-   * Tell us the custom params of the current document/resource to identify sub document inside a document.
-   * @param params Location
-   * @param appendLocation Append location to existing location
-   */
-  setLocation: (params: Location, appendLocation?: boolean) => void;
-  /**
-   * To remove document params from a User
-   * @deprecated This method is depercated and will be removed in next release. Use `removeLocation` method instead.
-   */
-  removeDocumentParams: () => void;
-  /**
-     * To remove location from a User
-     * @param location Location
-     */
-  removeLocation: (location?: Location) => void;
-  /**
-   * To exclude data of specific location ids
-   * @param ids Location Ids
-   */
-  excludeLocationIds: (ids: string[]) => void;
-  /**
-   * Tell us the about the scrollable document ids to keep track on its scroll changes
-   * @param ids scrollable elements ids
-   */
-  setScrollableElementsIds: (ids: string[]) => void;
-  /**
-   * To remove document params from a User
-   */
-  removeScrollableElementsIds: () => void;
-  /**
-   * Get the Presence Element Object to access the raw presence data.
-   *
-   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
-   */
-  getPresenceElement: () => PresenceElement;
-  /**
-   * Get the Cursor Element Object to access the raw cursor data.
-   *
-   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
-   */
-  getCursorElement: () => CursorElement;
-  /**
-   * Get the Comment Element Object to access the raw comment data.
-   *
-   * This is for Pros who don’t want to use Snippyly Comment web component and want to design their own UI.
-   */
-  getCommentElement: () => CommentElement;
-  /**
-   * Get the Tag Pin Annotation Object to access the raw tag data.
-   *
-   * This is for Pros who don’t want to use Snippyly Tag web component and want to design their own UI.
-   */
-  getTagElement: () => TagElement;
-  /**
-   * Get the Selection Object to enable/disable the feature.
-   */
-  getSelectionElement: () => SelectionElement;
-  /**
-   * Get the Recorder Object.
-   */
-  getRecorderElement: () => RecorderElement;
-  /**
-   * Get the Contact Object.
-   */
-  getContactElement: () => ContactElement;
-  /**
-   * Get the Rewriter Object.
-   */
-  getRewriterElement: () => RewriterElement;
-  /**
-   * Get the Huddle element.
-   */
-  getHuddleElement: () => HuddleElement;
-  /**
-   * Get the LiveStateSync Object.
-   */
-  getLiveStateSyncElement: () => LiveStateSyncElement;
-  /**
-   * Get the Arrow Object.
-   */
-  getArrowElement: () => ArrowElement;
-  /**
-   * Get the Views Object.
-   */
-  getViewsElement: () => ViewsElement;
-  /**
-   * Get the Notification Object.
-   */
-  getNotificationElement: () => NotificationElement;
-  /**
-   * Get the Autocomplete Object.
-   */
-  getAutocompleteElement: () => AutocompleteElement;
-  /**
-   * Get the Area Object.
-   */
-  getAreaElement: () => AreaElement;
-  /**
-   * Get the Area Object.
-   */
-  getReactionElement: () => ReactionElement;
-  /**
-   * Get the metadata of the current resource.
-   */
-  getMetadata: () => Promise<VeltEventMetadata | null>;
-  /**
-   * To signout a user
-   */
-  signOutUser: () => any;
-  /**
-   * Provide a list of features to disable.
-   * Provide an empty array to enable all the features.
-   * @param features List of features
-   */
-  disableFeatures: (features: Array<FeatureType>) => void;
-  /**
+   constructor();
+   initConfig: (apiKey: string, config?: Config) => void;
+   identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
+   /**
+    * Tell us who the currently logged in user is.
+    *
+    * Call whenever the user is updated: signs in, signs out, signs up etc.
+    * @deprecated This method is deprecated.
+    */
+   updateUser: (user: User) => void;
+   /**
+    * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
+    * @param id unique document ID
+    * @param documentMetadata Document Metadata
+    */
+   setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
+   /**
+    * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
+    * @param id unique document ID
+    * @deprecated This method is deprecated. Use `setDocuments` method instead.
+    */
+   setDocumentId: (id: string) => void;
+   /**
+    * To set multiple documents
+    */
+   setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
+   /**
+    * To unset the document id
+    * @deprecated This method is deprecated. Use `unsetDocuments` method instead.
+    */
+   unsetDocumentId: () => void;
+   /**
+    * To unset the documents
+    */
+   unsetDocuments: () => void;
+   /**
+    * To fetch documents
+    */
+   fetchDocuments: (options?: FetchDocumentsRequest) => Promise<FetchDocumentsResponse>;
+   /**
+    * To fetch folders
+    */
+   fetchFolders: (options?: FetchFoldersRequest) => Promise<FetchFoldersResponse>;
+   /**
+    * To set the user data provider.
+    */
+   setUserDataProvider: (userDataProvider: UserDataProvider) => void;
+   /**
+    * Get Document ID
+    */
+   getDocumentId: () => string;
+   /**
+    * Tell us the custom params of the current document/resource to identify sub document inside a document.
+    * @param params Location
+    * @param appendLocation Append location to existing location
+    */
+   setLocation: (params: Location, appendLocation?: boolean) => void;
+   /**
+      * To remove location from a User
+      * @param location Location
+      */
+   removeLocation: (location?: Location) => void;
+   /**
+    * To exclude data of specific location ids
+    * @param ids Location Ids
+    */
+   excludeLocationIds: (ids: string[]) => void;
+   /**
+    * Tell us the about the scrollable document ids to keep track on its scroll changes
+    * @param ids scrollable elements ids
+    */
+   setScrollableElementsIds: (ids: string[]) => void;
+   /**
+    * To remove document params from a User
+    */
+   removeScrollableElementsIds: () => void;
+   /**
+    * Get the Presence Element Object to access the raw presence data.
+    *
+    * This is for Pros who don't want to use Snippyly Presence web component and want to design their own UI.
+    */
+   getPresenceElement: () => PresenceElement;
+   /**
+    * Get the Cursor Element Object to access the raw cursor data.
+    *
+    * This is for Pros who don't want to use Snippyly Presence web component and want to design their own UI.
+    */
+   getCursorElement: () => CursorElement;
+   /**
+    * Get the Comment Element Object to access the raw comment data.
+    *
+    * This is for Pros who don't want to use Snippyly Comment web component and want to design their own UI.
+    */
+   getCommentElement: () => CommentElement;
+   /**
+    * Get the Tag Pin Annotation Object to access the raw tag data.
+    *
+    * This is for Pros who don't want to use Snippyly Tag web component and want to design their own UI.
+    */
+   getTagElement: () => TagElement;
+   /**
+    * Get the Selection Object to enable/disable the feature.
+    */
+   getSelectionElement: () => SelectionElement;
+   /**
+    * Get the Recorder Object.
+    */
+   getRecorderElement: () => RecorderElement;
+   /**
+    * Get the Contact Object.
+    */
+   getContactElement: () => ContactElement;
+   /**
+    * Get the Rewriter Object.
+    */
+   getRewriterElement: () => RewriterElement;
+   /**
+    * Get the Huddle element.
+    */
+   getHuddleElement: () => HuddleElement;
+   /**
+    * Get the LiveStateSync Object.
+    */
+   getLiveStateSyncElement: () => LiveStateSyncElement;
+   /**
+    * Get the Arrow Object.
+    */
+   getArrowElement: () => ArrowElement;
+   /**
+    * Get the Views Object.
+    */
+   getViewsElement: () => ViewsElement;
+   /**
+    * Get the Notification Object.
+    */
+   getNotificationElement: () => NotificationElement;
+   /**
+    * Get the Autocomplete Object.
+    */
+   getAutocompleteElement: () => AutocompleteElement;
+   /**
+    * Get the Area Object.
+    */
+   getAreaElement: () => AreaElement;
+   /**
+    * Get the Area Object.
+    */
+   getReactionElement: () => ReactionElement;
+   /**
+    * Get the metadata of the current resource.
+    */
+   getMetadata: () => Promise<VeltEventMetadata | null>;
+   /**
+    * To signout a user
+    */
+   signOutUser: () => any;
+   /**
+    * Provide a list of features to disable.
+    * Provide an empty array to enable all the features.
+    * @param features List of features
+    */
+   disableFeatures: (features: Array<FeatureType>) => void;
+   /**
    * Add location to show comments, tags, recorders etc. for provided location also.
    * @param location Location object
    * @deprecated This method is deprecated and will be removed in next release. Use `setLocation` method with `appendLocation: true` instead.
    */
-  addLocation: (location: any) => any;
-  /**
-   * To set the dark mode of Velt components.
-   * @param value {boolean} true/false
-   */
-  setDarkMode: (darkMode: boolean) => void;
-
-  /**
-   * To check if user allowed in provided document or not.
-   */
-  isUserAllowed$: () => Observable<boolean>;
+   addLocation: (location: any) => any;
+   /**
+    * To set the dark mode of Velt components.
+    * @param value {boolean} true/false
+    */
+   setDarkMode: (darkMode: boolean) => void;
 
-  /**
-   * To get user role in provided document.
-   */
-  getUserRole$: () => Observable<string | null>;
+   /**
+    * To check if user allowed in provided document or not.
+    */
+   isUserAllowed$: () => Observable<boolean>;
 
-  /**
-   * To check if plan is expired or not.
-   */
-  isPlanExpired$: () => Observable<boolean>;
+   /**
+    * To get user.
+    */
+   getUser: () => User | null;
 
-  /**
-   * To get if the Velt is initialized or not.
-   * @returns Observable<boolean | undefined>
-   */
-  getVeltInitState: () => Observable<boolean | undefined>;
+   /**
+    * To get user role in provided document.
+    */
+   getUserRole$: () => Observable<string | null>;
 
-  /**
-   * To invite list of users to the document.
-   * @param documentUsers List of document users
-   */
-  inviteUsers: (documentUsers: Array<DocumentUser>) => void;
+   /**
+    * To check if plan is expired or not.
+    */
+   isPlanExpired$: () => Observable<boolean>;
 
-  /**
-   * To remove snippyly specific content from provided html content.
-   */
-  removeSnippylyContent: (htmlContent: string) => string;
+   /**
+    * To get if the Velt is initialized or not.
+    * @returns Observable<boolean | undefined>
+    */
+   getVeltInitState: () => Observable<boolean | undefined>;
 
-  /**
-   * To remove velt specific content from provided html content.
-   */
+   /**
+    * To remove velt specific content from provided html content.
+    */
    removeVeltContent: (htmlContent: string) => string;
 
    /**
@@ -244,11 +248,10 @@ export declare class Snippyly {
    setLanguage: (language: string) => void;
 
    /**
-    * To set the translations for the language.
-    * @param language Language code
-    * @param translations Translations object
+    * To set translations for multiple languages
+    * @param translations Object containing translations for multiple languages
     */
-   setTranslations: (language: string, translations: { [key: string]: string }) => void;
+   setTranslations: (translations: { [language: string]: { [key: string]: string } }) => void;
 
    /**
     * To enable auto translation.
@@ -263,10 +266,11 @@ export declare class Snippyly {
    /**
     * To update user contact list.
     */
-   updateContactList: (userContacts: UserContact[], config?: {merge: boolean}) => void;
+   updateContactList: (userContacts: UserContact[], config?: { merge: boolean }) => void;
 
    /**
     * To get document metadata.
+    * @deprecated This method is deprecated. Use `fetchDocuments` method instead.
     */
    getDocumentMetadata: () => Observable<DocumentMetadata | null>;
 
@@ -274,4 +278,24 @@ export declare class Snippyly {
     * To subscribe to core actions
     */
    on: <T extends keyof CoreEventTypesMap>(action: T) => Observable<CoreEventTypesMap[T]>;
-}
+
+   /**
+   * To set the ui state.
+   */
+   setUiState: <T extends object>(uiState: T) => void;
+
+   /**
+    * To get the ui state.
+    */
+   getUiState: <T extends object>() => Observable<T>;
+
+   /**
+    * To enable logs.
+    */
+   enableLogs: () => void;
+
+   /**
+    * To disable logs.
+    */
+   disableLogs: () => void;
+}

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

@@ -0,0 +1,51 @@
+import { AnnotationProperty } from "./annotation-property.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { Location } from "./location.model";
+import { PageInfo } from "./page-info.model";
+import { TargetElement } from "./target-element.data.model";
+import { User } from "./user.data.model";
+export declare class ArrowAnnotation {
+    /**
+     * Unique identifier for the arrow pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * The user who created this arrow pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * Color used for the arrow pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * Timestamp when the arrow annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Target element of attached annotation.
+     */
+    targetElement?: TargetElement | null;
+    position?: CursorPosition | null;
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    type?: string;
+    props: AnnotationProperty;
+    /**
+     * To maintain index of current annotation in available list of annotations
+     * It will start from 1, so no need to add 1 in that.
+     */
+    annotationIndex?: number;
+    pageInfo?: PageInfo;
+}

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

@@ -4,4 +4,6 @@ export declare class BaseMetadata {
     clientDocumentId?: string;
     organizationId?: string;
     clientOrganizationId?: string;
+    folderId?: string;
+    veltFolderId?: string;
 }

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

@@ -9,8 +9,10 @@ import { User } from "./user.data.model";
 export interface RequestOptions {
     organizationId?: string;
     documentId?: string;
+    folderId?: string;
     filters?: any;
     documentIds?: string[];
+    allDocuments?: boolean;
 }
 export interface UpdatePriorityRequest {
     annotationId: string;
@@ -59,17 +61,13 @@ export interface DeleteCommentAnnotationRequest {
     annotationId: string;
     options?: RequestOptions;
 }
-export interface GetCommentAnnotationsRequest {
+export interface CommentRequestQuery {
     documentIds?: string[];
     locationIds?: string[];
     statusIds?: string[];
-    options?: RequestOptions;
-}
-export interface GetCommentAnnotationsCountRequest {
-    documentIds?: string[];
-    locationIds?: string[];
-    statusIds?: string[];
-    options?: RequestOptions;
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;
@@ -168,3 +166,18 @@ export interface ToggleReactionRequest {
     };
     options?: RequestOptions;
 }
+export interface FetchCommentAnnotationsRequest {
+    createdAfter?: number;
+    createdBefore?: number;
+    updatedAfter?: number;
+    updatedBefore?: number;
+    statusIds?: string[];
+    order?: 'asc' | 'desc';
+    pageToken?: string;
+    allDocuments?: boolean;
+    pageSize?: number;
+    organizationId?: string;
+    locationId?: string;
+    documentIds?: string[];
+    folderId?: string;
+}

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

@@ -77,6 +77,8 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.TOGGLE_REACTION]: ToggleReactionEvent;
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_INIT]: CommentSidebarDataInitEvent;
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
+    [CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
+    [CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -126,15 +128,14 @@ export interface DeleteCommentAnnotationEvent {
     commentAnnotation: CommentAnnotation;
     metadata: VeltEventMetadata;
 }
-export interface GetCommentAnnotationsEvent {
-    commentAnnotations: CommentAnnotation[];
-    metadata: VeltEventMetadata;
-}
 export interface GetCommentAnnotationsResponse {
-    data: Record<string, CommentAnnotation[]>;
+    data: Record<string, CommentAnnotation[]> | null;
+}
+export interface FetchCommentAnnotationsResponse extends GetCommentAnnotationsResponse {
+    nextPageToken: string;
 }
 export interface GetCommentAnnotationsCountResponse {
-    data: Record<string, CommentAnnotationsCount>;
+    data: Record<string, CommentAnnotationsCount> | null;
 }
 export interface CommentAnnotationsCount {
     unread: number;
@@ -239,3 +240,13 @@ export interface CommentSidebarDataInitEvent extends VeltButtonClickEvent {
 }
 export interface CommentSidebarDataUpdateEvent extends VeltButtonClickEvent {
 }
+export interface AutocompleteSearchEvent {
+    event: KeyboardEvent | InputEvent | Event;
+    searchText: string;
+    type?: 'contact' | 'custom' | 'group';
+    metadata?: VeltEventMetadata;
+}
+export interface ComposerClickedEvent {
+    commentAnnotation?: CommentAnnotation;
+    metadata?: VeltEventMetadata;
+}

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

@@ -6,3 +6,11 @@ export interface IUnreadCommentsCount {
     count: number;
 }
 export type UnreadCommentsCount = IUnreadCommentsCount | null;
+export interface TransformContext {
+    containerSelector: string;
+    transforms: {
+        scale: number;
+        transformOrigin: string;
+        inverseScale?: number;
+    };
+}

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

@@ -52,6 +52,7 @@ export declare class Config {
 }
 export interface ExtendedFirebaseOptions extends FirebaseOptions {
     storeDbId: string;
+    region?: string;
 }
 export interface AdvancedQueries {
     advancedQueriesEnabled: boolean;

package/app/models/data/cursor-position.data.model.d.ts

@@ -7,4 +7,19 @@ export declare class CursorPosition {
      * Position left of cursor on viewer user's screen
      */
     left: number;
+    /**
+     * Scale factor of the parent element in X direction
+     * Used for transform handling
+     */
+    parentScaleX?: number;
+    /**
+     * Scale factor of the parent element in Y direction
+     * Used for transform handling
+     */
+    parentScaleY?: number;
+    /**
+     * Transform context information
+     * Used to handle transforms properly
+     */
+    transformContext?: any;
 }

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

@@ -0,0 +1,8 @@
+import { DocumentMetadata } from "./document-metadata.model";
+import { FolderMetadata } from "./folder-metadata.model";
+export interface FetchDocumentsResponse {
+    data: Record<string, DocumentMetadata> | null;
+}
+export interface FetchFoldersResponse {
+    data: Record<string, FolderMetadata> | null;
+}

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

@@ -6,6 +6,14 @@ export declare class DocumentMetadata {
      * Unique document id generated from client document id
      */
     documentId?: string;
+    /**
+     * Folders
+     */
+    folderId?: string;
+    /**
+     * Velt folder id
+     */
+    veltFolderId?: string;
     /**
      * API key
      */

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

@@ -5,4 +5,27 @@ export interface Document {
 }
 export interface SetDocumentsRequestOptions {
     organizationId?: string;
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
+}
+export interface FetchDocumentsRequest {
+    organizationId?: string;
+    documentIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+}
+export interface FetchFoldersRequest {
+    organizationId?: string;
+    folderId?: string;
+}
+export interface FolderConfig {
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
+    veltFolderId?: string;
+}
+export interface OrganizationConfig {
+    organizationId: string;
+    clientOrganizationId: string;
 }

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

@@ -2,7 +2,7 @@ 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;
+    organization?: OrganizationMetadata | null;
+    documents?: DocumentMetadata[];
+    locations?: Location[];
 }

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

@@ -0,0 +1,40 @@
+export declare class FolderMetadata {
+    folderId?: string;
+    /**
+     * Velt folder id
+     */
+    veltFolderId?: string;
+    /**
+     * Parent folder id
+     */
+    parentFolderId?: string;
+    /**
+     * Velt parent folder id
+     */
+    veltParentFolderId?: string;
+    /**
+     * Created at
+     */
+    createdAt?: number;
+    /**
+     * Last updated
+     */
+    lastUpdated?: number;
+    /**
+     * API key
+     */
+    apiKey?: string;
+    /**
+     * Organization id
+     */
+    organizationId?: string;
+    /**
+     * Client organization id
+     */
+    clientOrganizationId?: string;
+    /**
+     * Folder name
+     */
+    folderName?: string;
+    [key: string]: any;
+}

package/app/models/data/multi-thread.data.model.d.ts

@@ -0,0 +1,61 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+import { CommentAnnotation, GhostComment, InlineCommentSectionConfig } from "./comment-annotation.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { Location } from "./location.model";
+import { TargetElement } from "./target-element.data.model";
+import { TargetTextRange } from "./target-text-range.data.model";
+import { User } from "./user.data.model";
+export declare class MultiThreadCommentAnnotation {
+    /**
+     * The id of the annotation.
+     */
+    annotationId: string;
+    /**
+     * The id of the area annotation.
+     */
+    areaAnnotationId?: string;
+    /**
+     * The target element of the annotation.
+     */
+    targetElement?: TargetElement | null;
+    /**
+     * The id of the target element.
+     */
+    targetElementId?: string | null;
+    /**
+     * Selected text range of comment annotation
+     */
+    targetTextRange?: TargetTextRange | null;
+    /**
+     * The id of the target inline comment element.
+     */
+    targetInlineCommentElementId?: string;
+    /**
+     * The inline comment section config.
+     */
+    inlineCommentSectionConfig?: InlineCommentSectionConfig;
+    commentAnnotations?: {
+        [commentAnnotationId: string]: boolean;
+    };
+    commentAnnotationsMap?: {
+        [commentAnnotationId: string]: CommentAnnotation;
+    };
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    position?: CursorPosition | null;
+    ghostComment?: GhostComment | null;
+    from: User;
+    type: string;
+    isDraft?: boolean;
+    sourceId?: string;
+    metadata?: MultiThreadMetadata;
+}
+export declare class MultiThreadMetadata extends BaseMetadata {
+    [key: string]: any;
+}

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

@@ -88,6 +88,11 @@ export declare class NotificationRawData {
         [key: string]: any;
     };
     displayBodyMessage?: string;
+    displayBodyMessageTemplate?: string;
+    displayBodyMessageTemplateData?: {
+        users?: User[];
+        [key: string]: any;
+    };
     customData?: any;
     notifyUsers?: {
         [email: string]: boolean;
@@ -127,6 +132,17 @@ export declare class Notification {
      * Notification body message
      */
     displayBodyMessage?: string;
+    /**
+       * Display body message template
+       */
+    displayBodyMessageTemplate?: string;
+    /**
+     * Display body message template data
+     */
+    displayBodyMessageTemplateData?: {
+        users?: User[];
+        [key: string]: any;
+    };
     /**
      * Display message template
      */

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

@@ -164,4 +164,10 @@ export declare class RecorderData {
     assets: RecorderDataAsset[];
     transcription: RecorderDataTranscription;
 }
+export interface RecorderRequestQuery {
+    recorderIds: string[];
+}
+export interface GetRecordingDataResponse {
+    data: Record<string, RecorderData> | null;
+}
 export {};

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

@@ -0,0 +1,8 @@
+import { RecorderEventTypes } from "../../utils/enums";
+import { RecorderData } from "./recorder-annotation.data.model";
+export interface TranscriptionDoneEvent {
+    data: Record<string, RecorderData> | null;
+}
+export type RecorderEventTypesMap = {
+    [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
+};

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

@@ -0,0 +1,5 @@
+import { User } from "./user.data.model";
+export interface UserDataProvider {
+    getUsers(userIds: string[]): Promise<Record<string, User>>;
+    resolveTimeout?: number;
+}

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

@@ -7,8 +7,8 @@ import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.
 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 { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, GetCommentAnnotationsRequest, GetCommentAnnotationsCountRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
-import { UnreadCommentsCount } from "../data/comment-utils.data.model";
+import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, CommentRequestQuery, CommentRequestQuery, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
+import { UnreadCommentsCount, TransformContext } from "../data/comment-utils.data.model";
 export declare class CommentElement {
   /**
    * Subscribe to comments on the current document.
@@ -921,142 +921,142 @@ export declare class CommentElement {
   /**
    * To add comment annotation
    */
-  public addCommentAnnotation: (config: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
+  public addCommentAnnotation: (request: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
 
   /**
    * To approve comment annotation
    */
-  public approveCommentAnnotation: (config: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
+  public approveCommentAnnotation: (request: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
 
   /**
    * To accept comment annotation
    */
-  public acceptCommentAnnotation: (config: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
+  public acceptCommentAnnotation: (request: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
 
   /**
    * To reject comment annotation
    */
-  public rejectCommentAnnotation: (config: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
+  public rejectCommentAnnotation: (request: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
 
   /**
    * To subscribe comment annotation
    */
-  public subscribeCommentAnnotation: (config: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
+  public subscribeCommentAnnotation: (request: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
 
   /**
    * To unsubscribe comment annotation
    */
-  public unsubscribeCommentAnnotation: (config: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
+  public unsubscribeCommentAnnotation: (request: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
 
   /**
    * To delete comment annotation
    */
-  public deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
+  public deleteCommentAnnotation: (request: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
 
   /**
    * To get comment annotations
    */
-  public getCommentAnnotations: (config: GetCommentAnnotationsRequest) => Observable<GetCommentAnnotationsEvent | null>;
+  public getCommentAnnotations: (query?: CommentRequestQuery) => Observable<GetCommentAnnotationsResponse>;
 
   /**
    * To get comment annotations count
    */
-  public getCommentAnnotationsCount: (config: GetCommentAnnotationsCountRequest) => Observable<GetCommentAnnotationsCountEvent | null>;
+  public getCommentAnnotationsCount: (query?: CommentRequestQuery) => Observable<GetCommentAnnotationsCountResponse>;
 
   /**
    * To assign user to comment annotation
    */
-  public assignUser: (config: AssignUserRequest) => Promise<AssignUserEvent | null>;
+  public assignUser: (request: AssignUserRequest) => Promise<AssignUserEvent | null>;
 
   /**
    * To update priority
    */
-  public updatePriority: (config: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
+  public updatePriority: (request: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
 
   /**
    * To update status
    */
-  public updateStatus: (config: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
+  public updateStatus: (request: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
 
   /**
    * To update access
    */
-  public updateAccess: (config: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
+  public updateAccess: (request: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
 
   /**
    * To resolve comment annotation
    */
-  public resolveCommentAnnotation: (config: ResolveCommentAnnotationRequest) => Promise<any>;
+  public resolveCommentAnnotation: (request: ResolveCommentAnnotationRequest) => Promise<any>;
 
   /**
    * To get link
    */
-  public getLink: (config: GetLinkRequest) => Promise<GetLinkEvent | null>;
+  public getLink: (request: GetLinkRequest) => Promise<GetLinkEvent | null>;
 
   /**
    * To copy link
    */
-  public copyLink: (config: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
+  public copyLink: (request: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
 
   /**
    * To add comment
    */
-  public addComment: (config: AddCommentRequest) => Promise<AddCommentEvent | null>;
+  public addComment: (request: AddCommentRequest) => Promise<AddCommentEvent | null>;
 
   /**
    * To update comment
    */
-  public updateComment: (config: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
+  public updateComment: (request: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
 
   /**
    * To delete comment
    */
-  public deleteComment: (config: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
+  public deleteComment: (request: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
 
   /**
    * To get comment
    */
-  public getComment: (config: GetCommentRequest) => Promise<Comment[]>;
+  public getComment: (request: GetCommentRequest) => Promise<Comment[]>;
 
   /**
    * To add attachment
    */
-  public addAttachment: (config: AddAttachmentRequest) => Promise<AddAttachmentResponse[]>;
+  public addAttachment: (request: AddAttachmentRequest) => Promise<AddAttachmentResponse[]>;
 
   /**
    * To get attachment
    */
-  public getAttachment: (config: GetAttachmentRequest) => Promise<Attachment[]>;
+  public getAttachment: (request: GetAttachmentRequest) => Promise<Attachment[]>;
 
   /**
    * To delete attachment
    */
-  public deleteAttachment: (config: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
+  public deleteAttachment: (request: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
 
   /**
    * To get recording
    */
-  public getRecording: (config: GetRecordingRequest) => Promise<RecordedData[]>;
+  public getRecording: (request: GetRecordingRequest) => Promise<RecordedData[]>;
 
   /**
    * To delete recording
    */
-  public deleteRecording: (config: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
+  public deleteRecording: (request: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
 
   /**
    * To add reaction
    */
-  public addReaction: (config: AddReactionRequest) => Promise<AddReactionEvent | null>;
+  public addReaction: (request: AddReactionRequest) => Promise<AddReactionEvent | null>;
 
   /**
    * To delete reaction
    */
-  public deleteReaction: (config: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
+  public deleteReaction: (request: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
 
   /**
    * To toggle reaction
    */
-  public toggleReaction: (config: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
+  public toggleReaction: (request: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
 
   /**
    * Subscribe to comment actions
@@ -1073,6 +1073,21 @@ export declare class CommentElement {
    */
   public disableReadOnly: () => void;
 
+  /**
+   * To enable custom autocomplete search
+   */
+  public enableCustomAutocompleteSearch: () => void;
+
+  /**
+   * To disable custom autocomplete search
+   */
+  public disableCustomAutocompleteSearch: () => void;
+
+  /**
+   * To set transform context
+   */
+  public setTransformContext: (transformContext: TransformContext) => void;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -2127,4 +2142,19 @@ export declare class CommentElement {
    * To disable read only
    */
   private _disableReadOnly;
+
+  /**
+   * To enable custom autocomplete search
+   */
+  private _enableCustomAutocompleteSearch;
+
+  /**
+   * To disable custom autocomplete search
+   */
+  private _disableCustomAutocompleteSearch;
+
+  /**
+   * To set transform context
+   */
+  private _setTransformContext;
 }

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

@@ -1,6 +1,7 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { RecorderData } from "../data/recorder-annotation.data.model";
+import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse } from "../data/recorder-annotation.data.model";
+import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
 
 export declare class RecorderElement {
 
@@ -20,6 +21,7 @@ export declare class RecorderElement {
 
     /**
      * To get recording data by recorder id
+     * @deprecated Use getRecordingData() method instead
      */
     getRecordingDataByRecorderId: (recorderId: string) => Observable<RecorderData | null>;
 
@@ -33,6 +35,16 @@ export declare class RecorderElement {
      */
     disableRecordingTranscription: () => void;
 
+    /**
+     * Subscribe to recorder actions
+     */
+    public on: <T extends keyof RecorderEventTypesMap>(action: T) => Observable<RecorderEventTypesMap[T]>;
+
+    /**
+     * To get recording data by recorder ids
+     */
+    getRecordingData: (query: RecorderRequestQuery) => Promise<GetRecordingDataResponse>;
+
     constructor();
 
     private _initRecording;
@@ -51,6 +63,7 @@ export declare class RecorderElement {
 
     /**
      * To get recording data by recorder id
+     * @deprecated Use getRecordingData() method instead
      */
     private _getRecordingDataByRecorderId;
 
@@ -63,4 +76,14 @@ export declare class RecorderElement {
      * To disable recording transcription
      */
     private _disableRecordingTranscription;
+
+    /**
+     * Subscribe to recorder actions
+     */
+    private _on;
+
+    /**
+     * To get recording data by recorder ids
+     */
+    private _getRecordingData;
 }

package/app/utils/constants.d.ts

@@ -8,10 +8,13 @@ export declare class Constants {
     static LOCALSTORAGE_DATA_ID: string;
     static NO_ORGANIZATION_ID: string;
     static DEFAULT_QUERY_HASH: string;
+    static LISTENER_BATCH_SIZE: number;
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
+    static FIREBASE_PARTIAL_PATH_FOLDERS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;
     static FIREBASE_PARTIAL_PATH_PRESENCE: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATION_USERS: string;
+    static FIREBASE_PARTIAL_PATH_FOLDER_USERS: string;
     static FIREBASE_PARTIAL_PATH_DOCUMENT_USERS: string;
     static FIREBASE_PARTIAL_PATH_CURSOR: string;
     static FIREBASE_PARTIAL_PATH_ARROW: string;
@@ -242,8 +245,8 @@ export declare class Constants {
         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;
-        VELT_OVERLAY: string;
     };
     static ATTRIBUTES: {
         VELT_TARGET_COMMENT_ELEMENT_ID: string;
@@ -253,6 +256,7 @@ export declare class Constants {
         TARGET_ELEMENT_ID: string;
         VELT_ID: string;
         VELT_ELEMENT: string;
+        VELT_SCREEN_RECORDER_PANEL: string;
         VELT_SOURCE_ID: string;
         VELT_ANNOTATION_ID: string;
         VELT_ANNOTATION_IDS: string;

package/app/utils/enums.d.ts

@@ -41,11 +41,17 @@ export declare const CommentEventTypes: {
     readonly TOGGLE_REACTION: "toggleReaction";
     readonly COMMENT_SIDEBAR_DATA_INIT: "commentSidebarDataInit";
     readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
+    readonly AUTOCOMPLETE_SEARCH: "autocompleteSearch";
+    readonly COMPOSER_CLICKED: "composerClicked";
+};
+export declare const RecorderEventTypes: {
+    readonly TRANSCRIPTION_DONE: "transcriptionDone";
 };
 export declare const CoreEventTypes: {
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
 };
 export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
+export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
 export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
 export declare enum TagStatus {
     ADDED = "added",

package/models.d.ts

@@ -1,6 +1,7 @@
 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/arrow-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';
@@ -17,6 +18,7 @@ export * from './app/models/data/custom-css.data.model';
 export * from './app/models/data/custom-chip-dropdown.data.model';
 export * from './app/models/data/device-info.model';
 export * from './app/models/data/document.data.model';
+export * from './app/models/data/document-events.data.model';
 export * from './app/models/data/document-iam.data.model';
 export * from './app/models/data/document-metadata.model';
 export * from './app/models/data/document-paths.data.model';
@@ -28,12 +30,14 @@ export * from './app/models/data/localstorage.data.model';
 export * from './app/models/data/location-metadata.model';
 export * from './app/models/data/location.model';
 export * from './app/models/data/media-preview-config.data.model';
+export * from './app/models/data/multi-thread.data.model';
 export * from './app/models/data/notification.model';
 export * from './app/models/data/page-info.model';
 export * from './app/models/data/permission.data.model';
 export * from './app/models/data/presence-user.data.model';
 export * from './app/models/data/recorder.model';
 export * from './app/models/data/recorder-annotation.data.model';
+export * from './app/models/data/recorder-events.data.model';
 export * from './app/models/data/rewriter-annotation.data.model';
 export * from './app/models/data/screen-size.data.model';
 export * from './app/models/data/selection.model';
@@ -62,3 +66,4 @@ export * from './app/models/data/organization-groups.data.model';
 export * from './app/models/data/organization-metadata.model';
 export * from './app/models/data/user-organization.data.model';
 export * from './app/models/data/event-metadata.data.model';
+export * from './app/models/data/user-resolver.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types-dev",
-    "version": "4.0.20",
+    "version": "4.1.0",
     "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": [