@veltdev/types 4.7.2 → 4.7.4

package/app/models/data/anchor-record.data.model.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Content hash for secure, privacy-preserving element validation.
+ */
+export interface ContentHash {
+    /** MD5 hash value (base36 encoded, ~12 characters) */
+    value: string;
+    /** Hashing algorithm (always 'md5') */
+    algorithm: 'md5';
+    /** Source of hash (always 'textContent') */
+    source: 'textContent';
+}
+/**
+ * Robust anchor record for reliable DOM element re-location.
+ *
+ * Survives:
+ * - Page reloads
+ * - Framework re-renders (React, Vue, Angular)
+ * - Dynamic ID changes
+ * - Minor DOM restructuring
+ *
+ * Does not survive:
+ * - Major redesigns
+ * - Content reordering (sort, filter)
+ * - Element removal
+ *
+ * **Resolution Strategy (priority order):**
+ * 1. id (90) - Stable, non-dynamic ID
+ * 2. css (80/60) - Attribute selector
+ * 3. robustXPath (50) - Attribute-based path
+ * 4. containerHints (40) - Scoped search
+ * 5. xPath variants (32-28) - Structural fallback
+ * 6. contentHash (15) - Hash-based scan
+ *
+ * **Validation boosts:** tagName (+10), contentHash (+30)
+ *
+ * **Security:** No plaintext storage, MD5 hash only.
+ */
+export interface AnchorRecord {
+    /** Schema version (current: "1.0") */
+    version: '1.0';
+    /**
+     * Stable element ID (non-dynamic only).
+     *
+     * Excluded patterns:
+     * - yui_* (YUI framework)
+     */
+    id?: string;
+    /** Tag name (uppercase, e.g., 'DIV', 'BUTTON') */
+    tagName: string;
+    /**
+     * CSS selector from stable attributes.
+     *
+     * Example: `[data-testid='submit-btn'][role='button']`
+     */
+    elementSelector?: string;
+    /**
+     * XPath variants (in order of stability):
+     *
+     * 1. robustXPath - Attribute-based (MOST STABLE)
+     *    - Prioritizes: data-* > role > stable ID > aria-* > position
+     *    - Example: `//div[@role='main']/.../li[5]/span`
+     *    - Ignores dynamic IDs
+     *    - Stops at landmarks (main, nav, etc.)
+     *
+     * 2. xPath - Basic XPath (uses IDs when available)
+     * 3. cfXPath - Positional with class hints
+     * 4. fXPath - Pure positional (most fragile)
+     */
+    robustXPath?: string;
+    xPath?: string;
+    fXPath?: string;
+    cfXPath?: string;
+    /**
+     * Content hash for secure validation.
+     */
+    contentHash?: ContentHash;
+    /** Creation timestamp (milliseconds since epoch) */
+    createdAt?: number;
+    /** Parent element anchor record */
+    parent?: AnchorRecord;
+}
+/**
+ * Result of anchor resolution.
+ */
+export interface AnchorResolution {
+    /** Resolved element (null if not found) */
+    element: Element | null;
+    /**
+     * Resolution method used.
+     * Values: 'id', 'css', 'robustXPath', 'xPath', 'cfXPath', 'fXPath', 'contentHash', 'ancestor+tag'
+     */
+    matchedBy?: string;
+    /**
+     * Confidence score (0-120+).
+     *
+     * - 90+: High (unique ID)
+     * - 80-89: Good (unique CSS, stable attributes)
+     * - 40-79: Moderate (scoped search, multiple candidates)
+     * - 15-39: Low (XPath, hash-based fallback)
+     */
+    score?: number;
+    /**
+     * Score breakdown.
+     */
+    scoreBreakdown?: {
+        method: string;
+        score: number;
+    }[];
+}

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

@@ -1,9 +1,10 @@
 import { AnnotationProperty } from "./annotation-property.data.model";
+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 { TargetElement } from "./target-element.data.model";
-import { User } from "./user.data.model";
+import { Context, User } from "./user.data.model";
 export declare class AreaAnnotation {
     /**
      * Unique identifier for the area pin annotation.
@@ -11,6 +12,7 @@ export declare class AreaAnnotation {
      * Auto generated.
      */
     annotationId: string;
+    context?: Context;
     /**
      * The user who created this area pin annotation.
      *
@@ -51,6 +53,7 @@ export declare class AreaAnnotation {
     pageInfo?: PageInfo;
     areaProperties?: AreaProperty;
     targetAnnotations: AreaTargetAnnotation[];
+    metadata?: AreaMetadata;
 }
 export declare class AreaTargetAnnotation {
     /**
@@ -72,3 +75,6 @@ export declare class AreaProperty {
     handle2?: any;
     coordinates?: any;
 }
+export declare class AreaMetadata extends BaseMetadata {
+    [key: string]: any;
+}

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

@@ -0,0 +1,52 @@
+import { ResolverActions } from "../../utils/enums";
+import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
+export interface AttachmentDataProvider {
+    save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
+    delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
+}
+export interface DeleteAttachmentResolverRequest {
+    attachmentId: number;
+    metadata?: AttachmentResolverMetadata;
+    event?: ResolverActions;
+}
+export interface SaveAttachmentResolverRequest {
+    attachment: ResolverAttachment;
+    metadata?: AttachmentResolverMetadata;
+    event?: ResolverActions;
+}
+export interface PartialAttachment {
+    url: string;
+    name: string;
+    attachmentId: number;
+}
+export interface ResolverAttachment {
+    attachmentId: number;
+    /**
+     * File to be uploaded
+     */
+    file: File;
+    /**
+     * File name
+     */
+    name?: string;
+    /**
+     * Metadata of an attachment
+     */
+    metadata?: AttachmentResolverMetadata;
+    /**
+     * Mime type of an attachment
+     */
+    mimeType?: string;
+}
+export interface AttachmentResolverMetadata {
+    organizationId: string | null;
+    documentId: string | null;
+    folderId?: string | null;
+    attachmentId: number | null;
+    commentAnnotationId: string | null;
+    apiKey: string | null;
+}
+export interface SaveAttachmentResolverData {
+    url: string;
+}

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

@@ -1,3 +1,4 @@
+import { RecorderFileFormat } from "../../utils/enums";
 export declare class Attachment {
     /**
      * Unique identifier for the comment pin annotation.
@@ -5,6 +6,10 @@ export declare class Attachment {
      * Auto generated.
      */
     attachmentId: number;
+    /**
+     * To check if attachment resolver is used
+     */
+    isAttachmentResolverUsed?: boolean;
     /**
      * File name
      */
@@ -20,7 +25,7 @@ export declare class Attachment {
     /**
      * File type
      */
-    type?: string;
+    type?: RecorderFileFormat;
     /**
      * Download url of a file
      */
@@ -38,4 +43,19 @@ export declare class Attachment {
      * Mime type of an attachment
      */
     mimeType?: any;
+    /**
+     * Preview images of an attachment
+     */
+    previewImages?: string[];
+}
+export interface UploadFileOptions {
+    path: string;
+    file: File;
+    useAttachmentResolver?: boolean;
+    metadata?: any;
+}
+export interface UploadFileData {
+    files: File[];
+    annotationId?: string;
+    targetElementId?: string;
 }

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

@@ -0,0 +1,51 @@
+import { OrganizationUserGroup } from "./organization-groups.data.model";
+import { UserContact } from "./user-contact.data.model";
+export declare class AutocompleteDataMap {
+    [hotkey: string]: AutocompleteData;
+}
+export declare class AutocompleteData {
+    hotkey: string;
+    description?: string;
+    type: 'custom' | 'contact' | 'group';
+    data: AutocompleteItem[];
+    groups?: AutocompleteGroup[];
+}
+export declare class AutocompleteItem {
+    id: string;
+    name: string;
+    description?: string;
+    icon?: {
+        url?: string;
+        svg?: string;
+    };
+    link?: string;
+    groupId?: string;
+}
+export declare class AutocompleteReplaceData {
+    text: string;
+    custom: AutocompleteItem;
+}
+export declare class AutocompleteGroupReplaceData {
+    text: string;
+    groupId: string;
+    clientGroupId: string;
+    group?: OrganizationUserGroup;
+}
+export declare class AutocompleteUserContactReplaceData {
+    text: string;
+    userId: string;
+    contact?: UserContact;
+}
+export declare class AutocompleteGroup {
+    id: string;
+    name: string;
+}
+export declare class AutocompleteChipData extends AutocompleteItem {
+    type: 'contact' | 'custom';
+}
+export declare class AutoCompleteScrollConfig {
+    itemSize?: number;
+    minBufferPx?: number;
+    maxBufferPx?: number;
+    templateCacheSize?: number;
+}

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

@@ -0,0 +1,9 @@
+export declare class BaseMetadata {
+    apiKey?: string;
+    documentId?: string;
+    clientDocumentId?: string;
+    organizationId?: string;
+    clientOrganizationId?: string;
+    folderId?: string;
+    veltFolderId?: string;
+}

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

@@ -0,0 +1,37 @@
+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;
+    data?: any;
+}
+export interface VeltButtonContext {
+    type?: string;
+    groupId?: string;
+    selections?: VeltButtonSelectionMap;
+    clickedButtonId?: string;
+}
+export interface VeltButtonData {
+    commentAnnotation?: CommentAnnotation;
+    comment?: Comment;
+    index?: number;
+    commentAnnotations?: CommentAnnotation[];
+    systemFilteredAnnotations?: CommentAnnotation[];
+    unreadCommentAnnotationsMap?: UnreadCommentsMap;
+    notification?: Notification;
+    notifications?: Notification[];
+}
+export interface VeltButtonSelectionMap {
+    [groupId: string]: {
+        [buttonId: string]: boolean;
+    };
+}
+export interface VeltResetButtonStateConfig {
+    id?: string;
+    group?: string;
+}

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

@@ -0,0 +1,199 @@
+import { CommentAccessMode } from "../../utils/enums";
+import { Attachment } from "./attachment.model";
+import { CommentAnnotation } from "./comment-annotation.data.model";
+import { Comment } from "./comment.data.model";
+import { CustomPriority, CustomStatus } from "./custom-filter.data.model";
+import { ReactionItem } from "./reaction-annotation.data.model";
+import { UserContact } from "./user-contact.data.model";
+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;
+    priority?: CustomPriority;
+    options?: RequestOptions;
+}
+export interface UpdateStatusRequest {
+    annotationId: string;
+    status: CustomStatus;
+    options?: RequestOptions;
+}
+export interface UpdateAccessRequest {
+    annotationId: string;
+    accessMode: CommentAccessMode;
+    options?: RequestOptions;
+}
+export interface ResolveCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface GetLinkRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface CopyLinkRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface AddCommentAnnotationRequest {
+    annotation: CommentAnnotation;
+    options?: RequestOptions;
+}
+export interface ApproveCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface AcceptCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface RejectCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface DeleteCommentAnnotationRequest {
+    annotationId: string;
+    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;
+    options?: RequestOptions;
+}
+export interface UnsubscribeCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface AssignUserRequest {
+    annotationId: string;
+    assignedTo: UserContact;
+    options?: RequestOptions;
+}
+export interface AddCommentRequest {
+    annotationId: string;
+    comment: Comment;
+    assignedTo?: User;
+    assigned?: boolean;
+    options?: RequestOptions;
+}
+export interface UpdateCommentRequest {
+    annotationId: string;
+    comment: Comment;
+    skipDeleteThreadConfirmation?: boolean;
+    merge?: boolean;
+    options?: RequestOptions;
+}
+export interface DeleteCommentRequest {
+    annotationId: string;
+    commentId: number;
+    skipDeleteThreadConfirmation?: boolean;
+    options?: RequestOptions;
+}
+export interface GetCommentRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
+export interface AddAttachmentRequest {
+    annotationId: string;
+    files: File[];
+    options?: RequestOptions;
+}
+export interface AddAttachmentResponse {
+    valid: boolean;
+    file?: File;
+    maxAllowedSize: number;
+    error?: string;
+    attachment?: Attachment;
+}
+export interface DeleteAttachmentRequest {
+    annotationId: string;
+    commentId: number;
+    attachmentId: number;
+    options?: RequestOptions;
+}
+export interface GetAttachmentRequest {
+    annotationId: string;
+    commentId: number;
+    options?: RequestOptions;
+}
+export interface GetRecordingRequest {
+    annotationId: string;
+    commentId: number;
+    options?: RequestOptions;
+}
+export interface DeleteRecordingRequest {
+    annotationId: string;
+    commentId: number;
+    recorderId: string;
+    options?: RequestOptions;
+}
+export interface AddReactionRequest {
+    annotationId: string;
+    commentId: number;
+    reaction: {
+        reactionId: string;
+        customReaction?: ReactionItem;
+    };
+    options?: RequestOptions;
+}
+export interface DeleteReactionRequest {
+    annotationId: string;
+    commentId: number;
+    reaction: {
+        reactionId: string;
+        customReaction?: ReactionItem;
+    };
+    options?: RequestOptions;
+}
+export interface ToggleReactionRequest {
+    annotationId: string;
+    commentId: number;
+    reaction: {
+        reactionId: string;
+        customReaction?: ReactionItem;
+    };
+    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;
+    resolvedBy?: string;
+    userIds?: string[];
+    mentionedUserIds?: string[];
+}
+export interface SubmitCommentRequest {
+    targetComposerElementId: string;
+}
+export interface ClearComposerRequest {
+    targetComposerElementId: string;
+}
+export interface GetComposerDataRequest {
+    targetComposerElementId: string;
+}