@veltdev/sdk 4.5.0-beta.8 → 4.5.0

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

@@ -3,7 +3,7 @@ import { Observable } from "rxjs";
 import { Config, DisableLogsConfig } from "../models/data/config.data.model";
 import { DocumentUser } from "../models/data/document-user.data.model";
 import { Location } from "../models/data/location.model";
-import { User, UserOptions } from "../models/data/user.data.model";
+import { User, UserOptions, VeltAuthProvider } from "../models/data/user.data.model";
 import { CustomCss } from "../models/data/custom-css.data.model";
 import { AreaElement } from "../models/element/area-element.model";
 import { ArrowElement } from "../models/element/arrow-element.model";
@@ -24,18 +24,22 @@ 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";
 import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
 import { UserDataProvider } 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";
+import { SetLocationsRequestOptions } from "../models/data/location.model";
 
 export declare class Snippyly {
    constructor();
    initConfig: (apiKey: string, config?: Config) => void;
    identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
+   setVeltAuthProvider: (veltAuthProvider: VeltAuthProvider) => Promise<User | null>;
    /**
     * Tell us who the currently logged in user is.
     *
@@ -48,17 +52,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.
@@ -91,6 +100,10 @@ export declare class Snippyly {
     * To set the data provider.
     */
    setDataProviders: (dataProvider: VeltDataProvider) => void;
+   /**
+    * To set the encryption provider.
+    */
+   setEncryptionProvider: (encryptionProvider: VeltEncryptionProvider) => void;
    /**
     * Get Document ID
     */
@@ -100,12 +113,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 +232,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 +255,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
@@ -312,8 +356,18 @@ export declare class Snippyly {
     */
    disableLogs: (config?: DisableLogsConfig) => void;
 
+   /**
+    * To enable safe eval.
+    */
+   enableSafeEval: () => void;
+
+   /**
+    * To disable safe eval.
+    */
+   disableSafeEval: () => void;
+
    /**
     * 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-actions.data.model.d.ts

@@ -62,12 +62,15 @@ export interface DeleteCommentAnnotationRequest {
     options?: RequestOptions;
 }
 export interface CommentRequestQuery {
+    organizationId?: string;
     documentIds?: string[];
     locationIds?: string[];
     statusIds?: string[];
     folderId?: string;
     allDocuments?: boolean;
     locationId?: string;
+    aggregateDocuments?: boolean;
+    filterGhostComments?: boolean;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;

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

@@ -9,6 +9,7 @@ import { PageInfo } from "./page-info.model";
 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 declare class CommentAnnotation {
     /**
      * Unique identifier for the comment pin annotation.
@@ -164,6 +165,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;
@@ -176,6 +181,8 @@ export declare class CommentAnnotation {
     multiThreadAnnotationId?: string;
     isDraft?: boolean;
     sourceId?: string;
+    views?: CommentAnnotationViews;
+    viewedByUserIds?: string[];
 }
 export declare class GhostComment {
     targetElement?: TargetElement | null;
@@ -244,3 +251,6 @@ export declare class CommentAnnotationSubscribedGroups {
 export declare class UpdateContextConfig {
     merge?: boolean;
 }
+export interface ContextOptions {
+    partialMatch?: boolean;
+}

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

@@ -29,6 +29,14 @@ export interface SaveCommentResolverRequest {
     metadata?: BaseMetadata;
     commentId?: string;
 }
+export interface PartialUser {
+    userId: string;
+}
+export interface PartialTaggedUserContacts {
+    userId: string;
+    contact?: PartialUser;
+    text?: string;
+}
 export interface PartialComment {
     commentId: string | number;
     commentHtml?: string;
@@ -36,6 +44,9 @@ export interface PartialComment {
     attachments?: {
         [attachmentId: number]: PartialAttachment;
     };
+    from?: PartialUser;
+    to?: PartialUser[];
+    taggedUserContacts?: PartialTaggedUserContacts[];
 }
 export interface PartialCommentAnnotationResult {
     strippedData: {
@@ -44,10 +55,18 @@ export interface PartialCommentAnnotationResult {
     originalData: CommentAnnotation | null;
     eventType?: ResolverActions;
 }
+export interface PartialTargetTextRange {
+    text: string;
+}
 export interface PartialCommentAnnotation {
     annotationId: string;
     metadata?: BaseMetadata;
     comments: {
         [commentId: string]: PartialComment;
     };
+    from?: PartialUser;
+    assignedTo?: PartialUser;
+    targetTextRange?: PartialTargetTextRange;
+    resolvedByUserId?: string | null;
+    [key: string]: any;
 }

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

@@ -1,12 +1,21 @@
 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;
@@ -14,11 +23,13 @@ export declare class CommentSidebarFilterConfig {
     people?: FilterTypeConfig;
     assigned?: FilterTypeConfig;
     tagged?: FilterTypeConfig;
+    involved?: FilterTypeConfig;
     priority?: FilterTypeConfig;
     status?: FilterTypeConfig;
     category?: FilterTypeConfig;
     commentType?: FilterTypeConfig;
     version?: FilterTypeConfig;
+    [key: string]: FilterTypeConfig | undefined;
 }
 export declare class CommentSidebarGroupConfig {
     enable?: boolean;
@@ -45,6 +56,11 @@ export declare class CommentSidebarFilters {
         email?: string;
         name?: string;
     }[];
+    involved?: {
+        userId?: string;
+        email?: string;
+        name?: string;
+    }[];
     priority?: string[];
     status?: string[];
     category?: string[];
@@ -52,6 +68,10 @@ export declare class CommentSidebarFilters {
         id: string;
         name?: string;
     }[];
+    [key: string]: {
+        id?: string;
+        name?: string;
+    }[] | string[] | undefined;
 }
 export interface CommentSidebarCustomActionsState {
     [key: string]: boolean;
@@ -61,6 +81,7 @@ export interface CommentSidebarCustomActionEventData {
     data: CommentAnnotation[];
     unreadDataMap: UnreadCommentsMap;
     systemFilteredData: CommentAnnotation[];
+    customFilters: CustomFilters;
 }
 export declare class CommentSidebarData {
     groupId?: string;

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

@@ -9,6 +9,7 @@ export declare class Comment {
      * Auto generated.
      */
     commentId: number;
+    context?: any;
     /**
      * This determines the comment content type.
      *

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/crdt.data.model.d.ts

@@ -0,0 +1,59 @@
+export interface CrdtVersion {
+    versionId: string;
+    versionName?: string;
+    state: Uint8Array | number[];
+    timestamp: number;
+}
+export interface CrdtVersionWithEncryptedState extends Omit<CrdtVersion, 'state'> {
+    encryptedState: string;
+}
+export interface CrdtUpdateDataQuery {
+    id: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtOnDataChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtGetDataQuery {
+    id: string;
+}
+export interface CrdtOnStateChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtUpdateStateQuery {
+    id: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtRegisterSyncUserQuery {
+    id: string;
+}
+export interface CrdtOnRegisteredUserChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtSetPresenceQuery {
+    id: string;
+}
+export interface CrdtOnPresenceChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtSaveVersionQuery {
+    id: string;
+    versionId: string;
+    versionName?: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtGetVersionQuery {
+    id: string;
+    versionId: string;
+}
+export interface CrdtGetVersionsQuery {
+    id: string;
+}
+export interface CrdtDeleteVersionQuery {
+    id: string;
+    versionId: string;
+}

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,19 @@ export declare class DocumentPaths {
      * The document's unique identifier.
      */
     documentId?: string;
+    folderId?: string;
+    locationId?: string;
+    allDocuments?: boolean;
+    veltFolderId?: string;
+    folder?: string;
     /**
      * Presence path.
      */
     presence?: string;
+    /**
+     * User config path.
+     */
+    userConfig?: string;
     docs?: string;
     /**
      * Cursor path.
@@ -64,6 +73,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/encryption-provider.data.model.d.ts

@@ -0,0 +1,12 @@
+export interface EncryptConfig<T = any> {
+    data: T;
+    type?: string;
+}
+export interface DecryptConfig<R = any> {
+    data: R;
+    type?: string;
+}
+export interface VeltEncryptionProvider<T = any, R = any> {
+    encrypt: (config: EncryptConfig<T>) => Promise<R>;
+    decrypt: (config: DecryptConfig<R>) => Promise<T>;
+}

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/media-preview-config.data.model.d.ts

@@ -2,11 +2,13 @@ export declare class MediaPreviewConfig {
     audio?: {
         enabled?: boolean;
         deviceId?: string;
+        stream?: MediaStream;
     };
     video?: {
         enabled?: boolean;
         deviceId?: string;
         track?: MediaStreamTrack;
+        stream?: MediaStream;
     };
     screen?: {
         enabled?: 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,25 @@ 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;
+}
+export interface GetNotificationsDataQuery {
+    type?: 'all' | 'forYou' | 'documents';
+}

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,18 +3,14 @@ import { PresenceUser } from "./presence-user.data.model";
 export interface PresenceMultipleUsersOnlineEvent {
     users: PresenceUser[];
 }
-export interface PresenceUserOnlineEvent {
-    user: PresenceUser;
-}
-export interface PresenceUserOfflineEvent {
-    user: PresenceUser;
-}
-export interface PresenceUserAwayEvent {
+export interface PresenceUserStateChangeEvent {
     user: PresenceUser;
+    state: string;
 }
 export type PresenceEventTypesMap = {
     [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
-    [PresenceEventTypes.USER_ONLINE]: PresenceUserOnlineEvent;
-    [PresenceEventTypes.USER_OFFLINE]: PresenceUserOfflineEvent;
-    [PresenceEventTypes.USER_AWAY]: PresenceUserAwayEvent;
+    [PresenceEventTypes.USER_STATE_CHANGE]: PresenceUserStateChangeEvent;
 };
+export interface GetPresenceDataResponse {
+    data: PresenceUser[] | null;
+}

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

@@ -1,7 +1,8 @@
+import { ResolverActions } from "../../utils/enums";
 import { BaseMetadata } from "./base-metadata.data.model";
+import { PartialUser } from "./comment-resolver.data.model";
 import { ReactionAnnotation } from "./reaction-annotation.data.model";
-import { ResolverResponse, ResolverConfig } from "./resolver.data.model";
-import { ResolverActions } from "../../utils/enums";
+import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface ReactionAnnotationDataProvider {
     get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
     save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
@@ -37,4 +38,5 @@ export interface PartialReactionAnnotation {
     annotationId: string;
     metadata?: BaseMetadata;
     icon?: string;
+    from?: PartialUser;
 }

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,10 +8,24 @@ export interface RecordingDeleteEvent extends RecorderData {
 }
 export interface RecordingEditDoneEvent extends RecorderData {
 }
+export interface RecordingActionsEvent {
+    type: 'audio' | 'video' | 'screen';
+}
+export interface RecordingStartedEvent extends RecordingActionsEvent {
+}
+export interface RecordingPausedEvent extends RecordingActionsEvent {
+}
+export interface RecordingCancelledEvent extends RecordingActionsEvent {
+}
+export interface RecordingStoppedEvent extends RecordingActionsEvent {
+}
+export interface RecordingResumedEvent extends RecordingActionsEvent {
+}
 export interface RecordingErrorEvent {
     type: string;
     message: string;
     recorderId?: string;
+    url?: string;
 }
 export interface RecordingSaveInitiatedEvent {
     annotationId?: string;
@@ -23,4 +37,9 @@ export type RecorderEventTypesMap = {
     [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;
     [RecorderEventTypes.RECORDING_EDIT_DONE]: RecordingEditDoneEvent;
     [RecorderEventTypes.DELETE_RECORDING]: RecordingDeleteEvent;
+    [RecorderEventTypes.RECORDING_STARTED]: RecordingStartedEvent;
+    [RecorderEventTypes.RECORDING_PAUSED]: RecordingPausedEvent;
+    [RecorderEventTypes.RECORDING_CANCELLED]: RecordingCancelledEvent;
+    [RecorderEventTypes.RECORDING_STOPPED]: RecordingStoppedEvent;
+    [RecorderEventTypes.RECORDING_RESUMED]: RecordingResumedEvent;
 };