@veltdev/types 4.7.2 → 4.7.3

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

@@ -0,0 +1,16 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+export interface Heartbeat {
+    id: string;
+    createdTimestamp: number;
+    userId: string;
+    veltUserId: string;
+    tabId: string;
+    metadata: BaseMetadata;
+    lastUpdatedTimestamp: number;
+}
+export interface HeartbeatConfig {
+    userId?: string;
+}
+export interface GetHeartbeatResponse {
+    data: Heartbeat[] | null;
+}

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

@@ -1,3 +1,4 @@
+import { HuddleType } from "../../utils/enums";
 import { User } from "./user.data.model";
 export declare class Attendee extends User {
     state?: {
@@ -12,7 +13,7 @@ export declare class Attendee extends User {
         screenSharing?: boolean;
     };
     streamMetadata?: any;
-    initialHuddleType?: 'audio' | 'video' | 'presentation';
+    initialHuddleType?: HuddleType;
     huddleOnCursorMode?: boolean;
 }
 export declare class Message {

package/app/models/data/live-state-data-map.data.model.d.ts

@@ -11,11 +11,12 @@ export declare class LiveStateDataMap {
      */
     default?: {
         singleEditor?: SingleEditorLiveStateData;
-        autoSyncState?: {
-            current?: LiveStateData;
-            history?: {
-                [liveStateDataId: string]: LiveStateData;
-            };
-        };
+        autoSyncState?: LiveStateAutoSyncState;
+    };
+}
+export declare class LiveStateAutoSyncState {
+    current?: LiveStateData;
+    history?: {
+        [liveStateDataId: string]: LiveStateData;
     };
 }

package/app/models/data/live-state-data.data.model.d.ts

@@ -1,3 +1,5 @@
+import { SingleEditorState, SingleEditorStatus } from "../../utils/enums";
+import { ErrorEvent } from "./core-events.data.model";
 import { User } from "./user.data.model";
 export declare class LiveStateData {
     /**
@@ -17,13 +19,20 @@ export declare class LiveStateData {
     lastUpdated: any;
     updatedBy: User;
     tabId?: string | null;
+    isDataStringified?: boolean;
+}
+export declare class SetLiveStateDataConfig {
+    /**
+     * To merge data with existing data.
+     */
+    merge?: boolean;
 }
 export declare class SingleEditorLiveStateData {
     editor?: User | null;
     requestEditorAccess?: {
         user: User;
         requestedAt: any;
-        status: 'pending' | 'accepted' | 'rejected' | 'cancelled';
+        status: SingleEditorStatus;
         editorAccessTimeout: number;
         tabId?: string | null;
     } | null;
@@ -55,9 +64,35 @@ export declare class EditorAccessTimer {
     /**
      * The time when the editor access was requested.
      */
-    state: 'idle' | 'inProgress' | 'completed';
+    state: SingleEditorState;
     /**
      * Duration left for the editor access timer to be completed.
      */
     durationLeft?: number;
 }
+export declare class LiveStateDataConfig {
+    listenToNewChangesOnly?: boolean;
+}
+export interface SetUserAsEditorResponse {
+    error?: ErrorEvent;
+}
+export interface LiveStateSingleEditorExternalUserPresence {
+    /**
+     * True if the same user is present on different tab.
+     */
+    sameUserPresentOnTab?: boolean;
+    /**
+     * True if the different user is present on different tab.
+     */
+    differentUserPresentOnTab?: boolean;
+    /**
+     * User ids of the users present on different tab.
+     */
+    userIds?: string[];
+}
+export interface FetchLiveStateDataRequest {
+    /**
+     * Unique identifier to identify the state data you are syncing.
+     */
+    liveStateDataId?: string;
+}

package/app/models/data/live-state-events.data.model.d.ts

@@ -0,0 +1,23 @@
+import { LiveStateSyncEventTypes } from "../../utils/enums";
+import { User } from "./user.data.model";
+export interface AccessRequestEvent {
+    viewer?: User;
+    editor?: User;
+    timestamp?: number;
+    status?: string;
+}
+export interface SEMEvent {
+    viewer?: User;
+    editor?: User;
+    timestamp?: number;
+    role?: string;
+}
+export type LiveStateEventTypesMap = {
+    [LiveStateSyncEventTypes.ACCESS_REQUESTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_REQUEST_CANCELED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_ACCEPTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_REJECTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.EDITOR_ASSIGNED]: SEMEvent;
+    [LiveStateSyncEventTypes.VIEWER_ASSIGNED]: SEMEvent;
+    [LiveStateSyncEventTypes.EDITOR_ON_DIFFERENT_TAB_DETECTED]: SEMEvent;
+};

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

@@ -1,3 +1,4 @@
+import { BaseMetadata } from "./base-metadata.data.model";
 import { Location } from "./location.model";
 import { PageInfo } from "./page-info.model";
 export declare class LocationMetadata {
@@ -5,6 +6,10 @@ export declare class LocationMetadata {
      * Unique location id generated from client location information
      */
     locationId?: number;
+    /**
+     * Location id generated from velt location information
+     */
+    veltLocationId?: string;
     /**
      * Location object provided by a client
      */
@@ -13,4 +18,13 @@ export declare class LocationMetadata {
      * Page metadata
      */
     pageInfo?: PageInfo;
+    /**
+     * Location metadata
+     */
+    metadata?: BaseMetadata;
+}
+export interface LocationMetadatas {
+    [documentId: string]: {
+        [locationId: string]: LocationMetadata;
+    };
 }

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

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

package/app/models/data/media-preview-config.data.model.d.ts

@@ -2,10 +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

@@ -0,0 +1,63 @@
+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;
+    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, TagStatus, UserActionTypes } from "../../utils/enums";
+import { AreaStatus, ArrowStatus, CommentStatus, CrdtActionTypes, 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";
@@ -19,11 +19,11 @@ export declare class NotificationRawData {
     /**
      * Source of a notification
      */
-    notificationSource?: 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
+    notificationSource?: NotificationSource;
     /**
      * Type of notification like 'Added', 'Updated' etc.
      */
-    actionType?: AreaStatus | ArrowStatus | CommentStatus | TagStatus | UserActionTypes;
+    actionType?: AreaStatus | ArrowStatus | CommentStatus | TagStatus | UserActionTypes | HuddleActionTypes | CrdtActionTypes;
     /**
      * Annotation object
      */
@@ -39,6 +39,8 @@ export declare class NotificationRawData {
     newStatus?: string;
     metadata?: DocumentMetadata & {
         apiKey?: string;
+        clientOrganizationId?: string;
+        organizationId?: string;
     } | null;
     documentUser?: DocumentUser;
     oldAccess?: string;
@@ -65,6 +67,8 @@ export declare class NotificationRawData {
         commenter?: {
             clientDocumentId: string;
             documentId: string;
+            clientOrganizationId?: string;
+            organizationId?: string;
             emails: string[];
             emailProperties: {
                 url?: string;
@@ -84,10 +88,17 @@ export declare class NotificationRawData {
         [key: string]: any;
     };
     displayBodyMessage?: string;
+    displayBodyMessageTemplate?: string;
+    displayBodyMessageTemplateData?: {
+        users?: User[];
+        [key: string]: any;
+    };
     customData?: any;
     notifyUsers?: {
         [email: string]: boolean;
     };
+    crdtData?: unknown;
+    notificationSourceData?: any;
 }
 export declare class Notification {
     /**
@@ -122,8 +133,123 @@ export declare class Notification {
      * Notification body message
      */
     displayBodyMessage?: string;
+    /**
+     * Is comment text available
+     */
+    isCommentResolverUsed?: boolean;
+    /**
+     * Display body message template
+       */
+    displayBodyMessageTemplate?: string;
+    /**
+     * Display body message template data
+     */
+    displayBodyMessageTemplateData?: {
+        users?: User[];
+        [key: string]: any;
+    };
+    /**
+     * Display message template
+     */
+    displayHeadlineMessageTemplate?: string;
+    /**
+     * Display message template data
+     */
+    displayHeadlineMessageTemplateData?: {
+        actionUser: User;
+        recipientUser: User;
+        actionMessage: string;
+        project: string;
+        [key: string]: any;
+    };
     /**
      * Is notification for you
      */
     forYou?: boolean;
+    /**
+     * Notification annotation target
+     */
+    targetAnnotationId?: string;
+    /**
+     * Notification annotation data
+     */
+    notificationSourceData?: any;
+    /**
+     * Notification metadata
+     */
+    metadata?: NotificationMetadata;
+    /**
+     * Notification notify users map by email hash
+     */
+    notifyUsers?: {
+        [email: string]: boolean;
+    };
+    /**
+     * Notification notify users map by user id hash
+     */
+    notifyUsersByUserId?: {
+        [userId: string]: boolean;
+    };
+}
+export declare class NotificationMetadata {
+    /**
+     * API Key
+     */
+    apiKey?: string;
+    /**
+     * Client organization ID
+     */
+    clientOrganizationId?: string;
+    /**
+     * Organization ID
+     */
+    organizationId?: string;
+    /**
+     * Client document ID
+     */
+    clientDocumentId?: string | number;
+    /**
+     * Document ID
+     */
+    documentId?: string;
+    /**
+     * Location ID
+     */
+    locationId?: number;
+    /**
+     * Location object
+     */
+    location?: Location;
+}
+export declare class NotificationTabConfigItem {
+    name?: string;
+    enable?: boolean;
+}
+export declare class NotificationTabConfig {
+    forYou?: NotificationTabConfigItem;
+    documents?: NotificationTabConfigItem;
+    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/organization-groups.data.model.d.ts

@@ -0,0 +1,16 @@
+import { User } from "./user.data.model";
+export declare class OrganizationUserGroup {
+    metadata: {
+        groupId: string;
+        clientGroupId: string;
+        groupName: string;
+    };
+    users: {
+        [userIdHash: string]: boolean;
+    };
+}
+export interface UserGroup {
+    groupId: string;
+    groupName: string;
+    users: User[];
+}

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

@@ -0,0 +1,31 @@
+import { DocumentMetadata } from "./document-metadata.model";
+import { PageInfo } from "./page-info.model";
+import { User } from "./user.data.model";
+export declare class OrganizationMetadata {
+    /**
+     * Unique organization id generated from client organization id
+     */
+    organizationId?: string;
+    /**
+     * API key
+     */
+    apiKey?: string;
+    /**
+     * Document id provided by client
+     */
+    clientOrganizationId?: string | number;
+    /**
+     * Page metadata
+     */
+    pageInfo?: PageInfo;
+    /**
+     *
+     */
+    documents?: {
+        [documentId: number]: DocumentMetadata;
+    };
+    /**
+     * Organization creator
+     */
+    creator?: User;
+}

package/app/models/data/page-info.model.d.ts

@@ -8,6 +8,10 @@ export declare class PageInfo {
      * Path of the webpage excluding base url
      */
     path?: string;
+    /**
+     * Query parameters of the webpage
+     */
+    queryParams?: string;
     /**
      * Base URL (domain) of a webpage
      */

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

@@ -0,0 +1,16 @@
+import { PresenceEventTypes } from "../../utils/enums";
+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/presence-user.data.model.d.ts

@@ -38,6 +38,10 @@ export declare class PresenceUser {
      * This is the color on the avatar border and live cursor, if these features are enabled.
      */
     color?: string;
+    /**
+    * This is the color on the avatar text.
+    */
+    textColor?: string;
     /**
      * Server Timestamp.
      *
@@ -76,4 +80,7 @@ export declare class PresenceUser {
      */
     isAnonymous?: boolean;
     pageInfo: PageInfo;
+    initial?: string;
+    isTabAway?: boolean;
+    isUserIdle?: boolean;
 }

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

@@ -0,0 +1,10 @@
+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";
+export interface VeltDataProvider {
+    comment?: CommentAnnotationDataProvider;
+    user?: UserDataProvider;
+    reaction?: ReactionAnnotationDataProvider;
+    attachment?: AttachmentDataProvider;
+}

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

@@ -0,0 +1,68 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { Location } from "./location.model";
+import { PageInfo } from "./page-info.model";
+import { Reaction } from "./reaction.data.model";
+import { TargetElement } from "./target-element.data.model";
+import { Context, User } from "./user.data.model";
+export declare class ReactionAnnotation {
+    /**
+     * Unique identifier for the reaction pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    context?: Context;
+    /**
+     * Connected comment annotation id of reaction annotation
+     */
+    commentAnnotationId?: string;
+    reactions?: Reaction[];
+    /**
+     * Timestamp when the reaction annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Target element of reaction annotation
+     */
+    targetElement?: TargetElement | null;
+    /**
+     * Target element id provided by user
+     */
+    targetElementId?: string | 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;
+    /**
+     * 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;
+    from?: User;
+    icon?: string;
+    isReactionResolverUsed?: boolean;
+    iconUrl?: string;
+    iconEmoji?: string;
+    metadata?: ReactionMetadata;
+}
+export declare class ReactionMetadata extends BaseMetadata {
+    [key: string]: any;
+}
+export declare class ReactionMap {
+    [reactionId: string]: ReactionItem;
+}
+export declare class ReactionItem {
+    url?: string;
+    svg?: string;
+    emoji?: string;
+}

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

@@ -0,0 +1,42 @@
+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 { ResolverConfig, ResolverResponse } from "./resolver.data.model";
+export interface ReactionAnnotationDataProvider {
+    get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
+    save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
+    delete: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
+}
+export interface GetReactionResolverRequest {
+    organizationId: string;
+    reactionAnnotationIds?: string[];
+    documentIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+}
+export interface DeleteReactionResolverRequest {
+    reactionAnnotationId: string;
+    metadata?: BaseMetadata;
+    event?: ResolverActions;
+}
+export interface SaveReactionResolverRequest {
+    reactionAnnotation: {
+        [key: string]: PartialReactionAnnotation;
+    };
+    metadata?: BaseMetadata;
+    event?: ResolverActions;
+}
+export interface PartialReactionAnnotationResult {
+    strippedData: {
+        [annotationId: string]: PartialReactionAnnotation;
+    } | null;
+    originalData: ReactionAnnotation | null;
+}
+export interface PartialReactionAnnotation {
+    annotationId: string;
+    metadata?: BaseMetadata;
+    icon?: string;
+    from?: PartialUser;
+}