@veltdev/sdk 4.5.0-beta.4 → 4.5.0-beta.41

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 { CrdtElement } from "../models/element/crdt-element.model";
 import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
 import { CoreEventTypesMap } from "../models/data/core-events.data.model";
 import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } from "../models/data/document.data.model";
@@ -31,6 +32,7 @@ import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/doc
 import { UserDataProvider } from "../models/data/user-resolver.data.model";
 import { VeltDataProvider } from "../models/data/provider.data.model";
 import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
+import { SetLocationsRequestOptions } from "../models/data/location.model";
 
 export declare class Snippyly {
    constructor();
@@ -48,17 +50,22 @@ export declare class Snippyly {
     * @param id unique document ID
     * @param documentMetadata Document Metadata
     */
-   setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
+   setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<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;
+   setDocumentId: (id: string) => Promise<void>;
    /**
     * To set multiple documents
     */
-   setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
+   setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => Promise<void>;
+   /**
+    * To set the root document
+    * @param document Document object
+    */
+   setRootDocument: (document: Document) => Promise<void>;
    /**
     * To unset the document id
     * @deprecated This method is deprecated. Use `unsetDocuments` method instead.
@@ -100,12 +107,39 @@ export declare class Snippyly {
     * @param params Location
     * @param appendLocation Append location to existing location
     */
-   setLocation: (params: Location, appendLocation?: boolean) => void;
+   setLocation: (params: Location, appendLocation?: boolean) => Promise<void>;
+
+   /**
+    * To set the root location
+    * @param location Location object
+    */
+   setRootLocation: (location: Location) => Promise<void>;
+
+   /**
+    * To set multiple locations
+    * @param locations Location objects
+    * @param options Set locations options
+    */
+   setLocations: (locations: Location[], options?: SetLocationsRequestOptions) => Promise<void>;
+
    /**
       * To remove location from a User
       * @param location Location
       */
    removeLocation: (location?: Location) => void;
+
+   /**
+    * To remove multiple locations
+    * @param locations Location objects
+    */
+   removeLocations: (locations?: Location[]) => void;
+
+   /**
+    * To remove location ids
+    * @param locationIds Location ids
+    */
+   unsetLocationIds: (locationIds?: string[]) => void;
+
    /**
     * To exclude data of specific location ids
     * @param ids Location Ids
@@ -192,6 +226,10 @@ export declare class Snippyly {
     * Get the Area Object.
     */
    getReactionElement: () => ReactionElement;
+   /**
+    * Get the CRDT Element Object.
+    */
+   getCrdtElement: () => CrdtElement;
    /**
     * Get the metadata of the current resource.
     */
@@ -211,7 +249,7 @@ export declare class Snippyly {
    * @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;
+   addLocation: (location: any) => Promise<any>;
    /**
     * To set the dark mode of Velt components.
     * @param value {boolean} true/false
@@ -315,5 +353,5 @@ export declare class Snippyly {
    /**
     * To reset the button toggle map.
     */
-  resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
+   resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
 }

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

@@ -1,11 +1,13 @@
 import { CommentAnnotation } from "./comment-annotation.data.model";
 import { UnreadCommentsMap } from "./comment-utils.data.model";
 import { Comment } from "./comment.data.model";
+import { CustomFilters } from "./custom-filter.data.model";
 import { VeltEventMetadata } from "./event-metadata.data.model";
 import { Notification } from "./notification.model";
 export interface VeltButtonClickEvent extends VeltButtonData {
     buttonContext?: VeltButtonContext;
     metadata?: VeltEventMetadata;
+    customFilters?: CustomFilters;
 }
 export interface VeltButtonContext {
     type?: string;

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

@@ -164,6 +164,10 @@ export declare class CommentAnnotation {
      * Custom context data provided by the user
      */
     context?: any;
+    /**
+     * Context id generated from context data
+     */
+    contextId?: string;
     iam: CommentIAMConfig;
     isPageAnnotation?: boolean;
     targetInlineCommentElementId?: string;
@@ -244,3 +248,6 @@ export declare class CommentAnnotationSubscribedGroups {
 export declare class UpdateContextConfig {
     merge?: boolean;
 }
+export interface ContextOptions {
+    partialMatch?: boolean;
+}

package/app/models/data/comment-sidebar-config.model.d.ts

@@ -1,15 +1,25 @@
 import { CommentAnnotation } from "./comment-annotation.data.model";
 import { UnreadCommentsMap } from "./comment-utils.data.model";
+import { CustomFilters } from "./custom-filter.data.model";
 import { Location } from "./location.model";
+declare class FilterOption {
+    id: string;
+    name: string;
+}
 declare class FilterTypeConfig {
     name?: string;
     enable?: boolean;
     multiSelection?: boolean;
     enableGrouping?: boolean;
     order?: string[];
+    placeholder?: string;
+    id?: string;
+    type?: 'custom' | 'system';
+    options?: FilterOption[];
 }
 export declare class CommentSidebarFilterConfig {
     location?: FilterTypeConfig;
+    document?: FilterTypeConfig;
     people?: FilterTypeConfig;
     assigned?: FilterTypeConfig;
     tagged?: FilterTypeConfig;
@@ -18,6 +28,7 @@ export declare class CommentSidebarFilterConfig {
     category?: FilterTypeConfig;
     commentType?: FilterTypeConfig;
     version?: FilterTypeConfig;
+    [key: string]: FilterTypeConfig | undefined;
 }
 export declare class CommentSidebarGroupConfig {
     enable?: boolean;
@@ -25,6 +36,10 @@ export declare class CommentSidebarGroupConfig {
 }
 export declare class CommentSidebarFilters {
     location?: Location[];
+    document?: {
+        id?: string;
+        documentName?: string;
+    }[];
     people?: {
         userId?: string;
         email?: string;
@@ -47,6 +62,10 @@ export declare class CommentSidebarFilters {
         id: string;
         name?: string;
     }[];
+    [key: string]: {
+        id?: string;
+        name?: string;
+    }[] | string[] | undefined;
 }
 export interface CommentSidebarCustomActionsState {
     [key: string]: boolean;
@@ -56,6 +75,7 @@ export interface CommentSidebarCustomActionEventData {
     data: CommentAnnotation[];
     unreadDataMap: UnreadCommentsMap;
     systemFilteredData: CommentAnnotation[];
+    customFilters: CustomFilters;
 }
 export declare class CommentSidebarData {
     groupId?: string;

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

@@ -6,10 +6,19 @@ export type CoreEventTypesMap = {
     [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
     [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
     [CoreEventTypes.ERROR]: ErrorEvent;
+    [CoreEventTypes.INIT_UPDATE]: InitUpdateEvent;
 };
 export type UserUpdateEvent = User | null;
 export type DocumentInitEvent = boolean | undefined;
 export type ErrorEvent = {
+    error?: string;
     code: string;
     message?: string;
+    source?: string;
+};
+export type InitUpdateEvent = {
+    event: string;
+    methodName?: string;
+    source?: string;
+    payload?: any;
 };

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

@@ -13,6 +13,14 @@ export interface CustomStatus extends CustomFilter {
     svg?: string;
     iconUrl?: string;
 }
+export interface CustomFilterOption {
+    id: string;
+    name: string;
+    selected: boolean;
+}
+export interface CustomFilters {
+    [key: string]: CustomFilterOption[];
+}
 export interface CustomCategory extends CustomFilter {
 }
 export interface CustomCategoryMap {

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

@@ -3,10 +3,18 @@ export declare class DocumentPaths {
      * The document's unique identifier.
      */
     documentId?: string;
+    folderId?: string;
+    locationId?: string;
+    allDocuments?: boolean;
+    veltFolderId?: string;
     /**
      * Presence path.
      */
     presence?: string;
+    /**
+     * User config path.
+     */
+    userConfig?: string;
     docs?: string;
     /**
      * Cursor path.
@@ -64,6 +72,10 @@ export declare class DocumentPaths {
      * User login path.
      */
     logins?: string;
+    /**
+     * CRDT path.
+     */
+    crdt?: string;
     /**
      * Selection path.
      */

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

@@ -8,9 +8,11 @@ export interface SetDocumentsRequestOptions {
     folderId?: string;
     allDocuments?: boolean;
     locationId?: string;
+    rootDocumentId?: string;
 }
 export interface UpdateDocumentsRequest<T = unknown> {
     organizationId?: string;
+    folderId?: string;
     documents?: UpdateDocumentMetadata<T>[];
 }
 export interface UpdateDocumentMetadata<T = unknown> {

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

@@ -23,3 +23,13 @@ export declare class Version {
      */
     name: string;
 }
+export declare class SetLocationsRequestOptions {
+    /**
+     * Root location.
+     */
+    rootLocationId?: string;
+    /**
+     * Merge locations.
+     */
+    appendLocation?: boolean;
+}

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

@@ -55,6 +55,8 @@ export declare class MultiThreadCommentAnnotation {
     isDraft?: boolean;
     sourceId?: string;
     metadata?: MultiThreadMetadata;
+    isTemporary?: boolean;
+    context?: any;
 }
 export declare class MultiThreadMetadata extends BaseMetadata {
     [key: string]: any;

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

@@ -1,4 +1,4 @@
-import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
+import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSettingsItemType, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
 import { DocumentMetadata } from "./document-metadata.model";
 import { DocumentUser } from "./document-user.data.model";
 import { Location } from "./location.model";
@@ -230,3 +230,22 @@ export declare class NotificationTabConfig {
     all?: NotificationTabConfigItem;
     people?: NotificationTabConfigItem;
 }
+export declare class NotificationInitialSettingsConfig {
+    name?: string;
+    id: string;
+    default?: string;
+    enable?: boolean;
+    values?: NotificationConfigValue[];
+}
+export declare class NotificationConfigValue {
+    name?: string;
+    id: NotificationSettingsItemType;
+}
+export declare class NotificationSettingsConfig {
+    [key: string]: NotificationSettingsItemType;
+}
+export interface NotificationsDocConfig {
+    inbox: 'ALL' | 'NONE' | 'MINE';
+    email: 'ALL' | 'NONE' | 'MINE';
+    [key: string]: string;
+}

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

@@ -0,0 +1,9 @@
+import { NotificationSettingsConfig } from "./notification.model";
+import { NotificationEventTypes } from "../../utils/enums";
+export interface SettingsUpdatedEvent {
+    settings: NotificationSettingsConfig;
+    isMutedAll: boolean;
+}
+export type NotificationEventTypesMap = {
+    [NotificationEventTypes.SETTINGS_UPDATED]: SettingsUpdatedEvent;
+};

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

@@ -0,0 +1,5 @@
+export interface PresenceRequestQuery {
+    documentId?: string;
+    organizationId?: string;
+    statuses?: string[];
+}

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

@@ -3,6 +3,14 @@ import { PresenceUser } from "./presence-user.data.model";
 export interface PresenceMultipleUsersOnlineEvent {
     users: PresenceUser[];
 }
+export interface PresenceUserStateChangeEvent {
+    user: PresenceUser;
+    state: string;
+}
 export type PresenceEventTypesMap = {
     [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
+    [PresenceEventTypes.USER_STATE_CHANGE]: PresenceUserStateChangeEvent;
 };
+export interface GetPresenceDataResponse {
+    data: PresenceUser[] | null;
+}

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

@@ -180,6 +180,8 @@ export interface RecorderBoundedScaleRange {
     centerY?: number;
     topLeftX?: number;
     topLeftY?: number;
+    topLeftXPixels?: number;
+    topLeftYPixels?: number;
 }
 export interface RecorderEditRange {
     trimRanges: RecorderBoundedTrimRange[];
@@ -213,6 +215,7 @@ declare class RecorderDataAsset {
      */
     fileFormat?: RecorderFileFormat;
     thumbnailUrl?: string;
+    transcription: RecorderDataTranscription;
 }
 export declare class RecorderData {
     recorderId: string;

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

@@ -8,6 +8,16 @@ export interface RecordingDeleteEvent extends RecorderData {
 }
 export interface RecordingEditDoneEvent extends RecorderData {
 }
+export interface RecordingErrorEvent {
+    type: string;
+    message: string;
+    recorderId?: string;
+}
+export interface RecordingSaveInitiatedEvent {
+    annotationId?: string;
+    message: string;
+    type: 'edit' | 'record';
+}
 export type RecorderEventTypesMap = {
     [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
     [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;

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

@@ -93,15 +93,13 @@ export declare class RecordedData {
     };
     getThumbnailTag: (url?: string) => string;
 }
+export declare class RecorderQualityConstraintsOptions {
+    video?: MediaTrackConstraints;
+    audio?: MediaTrackConstraints;
+}
 export declare class RecorderQualityConstraints {
-    safari?: {
-        video?: MediaTrackConstraints;
-        audio?: MediaTrackConstraints;
-    };
-    other?: {
-        video?: MediaTrackConstraints;
-        audio?: MediaTrackConstraints;
-    };
+    safari?: RecorderQualityConstraintsOptions;
+    other?: RecorderQualityConstraintsOptions;
 }
 export declare class RecorderEncodingOptions {
     safari?: MediaRecorderOptions;

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

@@ -3,6 +3,12 @@ export interface ResolverConfig {
     saveRetryConfig?: RetryConfig;
     deleteRetryConfig?: RetryConfig;
     getRetryConfig?: RetryConfig;
+    resolveUsersConfig?: ResolveUsersConfig;
+}
+export interface ResolveUsersConfig {
+    organization?: boolean;
+    folder?: boolean;
+    document?: boolean;
 }
 export interface ResolverResponse<T> {
     data?: T;

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

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

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

@@ -126,7 +126,7 @@ export declare class CommentElement {
 
   /**
    * Subscribe to comment mode change.
-   * 
+   *
    * Returns Observable<boolean>.
    */
   onCommentModeChange: () => Observable<boolean>;
@@ -278,7 +278,7 @@ export declare class CommentElement {
 
   /**
    * @description Sets custom status filters
-   * @param statuses 
+   * @param statuses
    */
   setCustomStatus: (statuses: CustomStatus[]) => void;
 
@@ -326,7 +326,7 @@ export declare class CommentElement {
 
   /**
    * @description Sets the comment context provider
-   * @param provider 
+   * @param provider
    */
   public setContextProvider: (provider: (documentId: string, location?: any) => any) => void;
 
@@ -397,14 +397,14 @@ export declare class CommentElement {
 
   /**
    * To get documentId, location and set context data when comment is added.
-   * 
+   *
    * @legacy Use `AddCommentAnnotationEvent` instead
    */
   public onCommentAdd: () => Observable<CommentAddEventData>;
 
   /**
    * To get data when comment is updated.
-   * 
+   *
    * @legacy Use action specific events instead
    */
   public onCommentUpdate: () => Observable<CommentUpdateEventData>;
@@ -791,6 +791,28 @@ export declare class CommentElement {
    */
   public disableMultiThread: () => void;
 
+  /**
+   * To enable group multiple match
+   * @deprecated Use enableGroupMatchedComments instead
+   */
+  public enableGroupMultipleMatch: () => void;
+
+  /**
+   * To disable group multiple match
+   * @deprecated Use disableGroupMatchedComments instead
+   */
+  public disableGroupMultipleMatch: () => void;
+
+  /**
+   * To enable group matched comments
+   */
+  public enableGroupMatchedComments: () => void;
+
+  /**
+   * To disable group matched comments
+   */
+  public disableGroupMatchedComments: () => void;
+
   /**
    * To update context of comment annotation
    * @param annotationId Comment annotation id
@@ -1140,6 +1162,32 @@ export declare class CommentElement {
    * To disable draft mode
    */
   public disableDraftMode: () => void;
+
+  /**
+   * To enable filter comments on dom
+   */
+  public enableFilterCommentsOnDom: () => void;
+
+  /**
+   * To disable filter comments on dom
+   */
+  public disableFilterCommentsOnDom: () => void;
+
+  /**
+   * To enable reply avatars
+   */
+  public enableReplyAvatars: () => void;
+
+  /**
+   * To disable reply avatars
+   */
+  public disableReplyAvatars: () => void;
+
+  /**
+   * To set max reply avatars
+   */
+  public setMaxReplyAvatars: (maxReplyAvatars: number) => void;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -1255,7 +1303,7 @@ export declare class CommentElement {
 
   /**
    * Subscribe to comment mode change.
-   * 
+   *
    * Returns Observable<boolean>.
    */
   private _onCommentModeChange;
@@ -1402,7 +1450,7 @@ export declare class CommentElement {
 
   /**
    * @description Sets custom status filters
-   * @param statuses 
+   * @param statuses
    */
   private _setCustomStatus;
 
@@ -1450,7 +1498,7 @@ export declare class CommentElement {
 
   /**
    * @description Sets the comment context provider
-   * @param provider 
+   * @param provider
    */
   private _setContextProvider;
 
@@ -1695,7 +1743,7 @@ export declare class CommentElement {
    */
   private _disableRecordingSummary;
 
-  /** 
+  /**
    * To enable recording transcription
    */
   private _enableRecordingTranscription;
@@ -1910,6 +1958,28 @@ export declare class CommentElement {
    */
   private _disableMultiThread;
 
+  /**
+   * To enable group multiple match
+   * @deprecated Use enableGroupMatchedComments instead
+   */
+  private _enableGroupMultipleMatch;
+
+  /**
+   * To disable group multiple match
+   * @deprecated Use disableGroupMatchedComments instead
+   */
+  private _disableGroupMultipleMatch;
+
+  /**
+   * To enable group matched comments
+   */
+  private _enableGroupMatchedComments;
+
+  /**
+   * To disable group matched comments
+   */
+  private _disableGroupMatchedComments;
+
   /**
    * To update context of comment annotation
    * @param annotationId Comment annotation id
@@ -1968,7 +2038,7 @@ export declare class CommentElement {
    */
   private _disableQueryParamsComments;
 
-  /** 
+  /**
    * To enable comment sidebar action button click
    */
   private _onCommentSidebarActionButtonClick;
@@ -2260,4 +2330,29 @@ export declare class CommentElement {
    * To disable draft mode
    */
   private _disableDraftMode;
+
+  /**
+   * To enable filter comments on dom
+   */
+  private _enableFilterCommentsOnDom;
+
+  /**
+   * To disable filter comments on dom
+   */
+  private _disableFilterCommentsOnDom;
+
+  /**
+   * To enable reply avatars
+   */
+  private _enableReplyAvatars;
+
+  /**
+   * To disable reply avatars
+   */
+  private _disableReplyAvatars;
+
+  /**
+   * To set max reply avatars
+   */
+  private _setMaxReplyAvatars;
 }