@veltdev/types 4.7.1 → 4.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/app/models/data/area-annotation.data.model.d.ts +1 -7
  2. package/app/models/data/attachment.model.d.ts +1 -21
  3. package/app/models/data/comment-annotation.data.model.d.ts +4 -80
  4. package/app/models/data/comment.data.model.d.ts +1 -26
  5. package/app/models/data/config.data.model.d.ts +0 -23
  6. package/app/models/data/cursor-position.data.model.d.ts +0 -15
  7. package/app/models/data/cursor-user.data.model.d.ts +0 -5
  8. package/app/models/data/custom-filter.data.model.d.ts +0 -8
  9. package/app/models/data/document-iam.data.model.d.ts +0 -8
  10. package/app/models/data/document-metadata.model.d.ts +0 -28
  11. package/app/models/data/document-paths.data.model.d.ts +1 -51
  12. package/app/models/data/huddle.model.d.ts +1 -2
  13. package/app/models/data/live-state-data-map.data.model.d.ts +6 -7
  14. package/app/models/data/live-state-data.data.model.d.ts +2 -37
  15. package/app/models/data/location-metadata.model.d.ts +0 -14
  16. package/app/models/data/location.model.d.ts +2 -0
  17. package/app/models/data/media-preview-config.data.model.d.ts +0 -3
  18. package/app/models/data/notification.model.d.ts +3 -129
  19. package/app/models/data/page-info.model.d.ts +0 -4
  20. package/app/models/data/presence-user.data.model.d.ts +0 -7
  21. package/app/models/data/recorder-annotation.data.model.d.ts +9 -101
  22. package/app/models/data/recorder.model.d.ts +2 -31
  23. package/app/models/data/selection.model.d.ts +0 -12
  24. package/app/models/data/target-element.data.model.d.ts +0 -5
  25. package/app/models/data/target-text-range.data.model.d.ts +0 -13
  26. package/app/models/data/user-contact.data.model.d.ts +0 -21
  27. package/app/models/data/user-iam.data.model.d.ts +0 -15
  28. package/app/models/data/user.data.model.d.ts +0 -82
  29. package/app/utils/constants.d.ts +6 -133
  30. package/app/utils/enums.d.ts +4 -208
  31. package/models.d.ts +0 -36
  32. package/package.json +2 -2
  33. package/app/models/data/anchor-record.data.model.d.ts +0 -109
  34. package/app/models/data/arrow-annotation.data.model.d.ts +0 -51
  35. package/app/models/data/attachment-resolver.data.model.d.ts +0 -52
  36. package/app/models/data/autocomplete.data.model.d.ts +0 -51
  37. package/app/models/data/base-metadata.data.model.d.ts +0 -9
  38. package/app/models/data/button.data.model.d.ts +0 -37
  39. package/app/models/data/comment-actions.data.model.d.ts +0 -190
  40. package/app/models/data/comment-events.data.model.d.ts +0 -272
  41. package/app/models/data/comment-resolver.data.model.d.ts +0 -72
  42. package/app/models/data/comment-sidebar-config.model.d.ts +0 -95
  43. package/app/models/data/comment-utils.data.model.d.ts +0 -16
  44. package/app/models/data/contact-utils.data.model.d.ts +0 -9
  45. package/app/models/data/core-events.data.model.d.ts +0 -180
  46. package/app/models/data/crdt-events.data.model.d.ts +0 -25
  47. package/app/models/data/crdt.data.model.d.ts +0 -60
  48. package/app/models/data/custom-chip-dropdown.data.model.d.ts +0 -10
  49. package/app/models/data/custom-css.data.model.d.ts +0 -10
  50. package/app/models/data/customer-metadata.data.model.d.ts +0 -15
  51. package/app/models/data/document-events.data.model.d.ts +0 -8
  52. package/app/models/data/document.data.model.d.ts +0 -63
  53. package/app/models/data/encryption-provider.data.model.d.ts +0 -12
  54. package/app/models/data/event-metadata.data.model.d.ts +0 -32
  55. package/app/models/data/folder-metadata.model.d.ts +0 -40
  56. package/app/models/data/heartbeat.data.model.d.ts +0 -16
  57. package/app/models/data/live-state-events.data.model.d.ts +0 -23
  58. package/app/models/data/multi-thread.data.model.d.ts +0 -63
  59. package/app/models/data/notifications-events.data.model.d.ts +0 -9
  60. package/app/models/data/organization-groups.data.model.d.ts +0 -16
  61. package/app/models/data/organization-metadata.model.d.ts +0 -31
  62. package/app/models/data/presence-actions.data.model.d.ts +0 -5
  63. package/app/models/data/presence-events.data.model.d.ts +0 -16
  64. package/app/models/data/provider.data.model.d.ts +0 -10
  65. package/app/models/data/reaction-annotation.data.model.d.ts +0 -68
  66. package/app/models/data/reaction-resolver.data.model.d.ts +0 -42
  67. package/app/models/data/reaction.data.model.d.ts +0 -18
  68. package/app/models/data/recorder-events.data.model.d.ts +0 -45
  69. package/app/models/data/resolver.data.model.d.ts +0 -36
  70. package/app/models/data/screenshot.data.model.d.ts +0 -10
  71. package/app/models/data/sync-video-player.data.model.d.ts +0 -47
  72. package/app/models/data/user-organization.data.model.d.ts +0 -12
  73. package/app/models/data/user-resolver.data.model.d.ts +0 -56
  74. package/app/models/data/views.data.model.d.ts +0 -64
@@ -1,109 +0,0 @@
1
- /**
2
- * Content hash for secure, privacy-preserving element validation.
3
- */
4
- export interface ContentHash {
5
- /** MD5 hash value (base36 encoded, ~12 characters) */
6
- value: string;
7
- /** Hashing algorithm (always 'md5') */
8
- algorithm: 'md5';
9
- /** Source of hash (always 'textContent') */
10
- source: 'textContent';
11
- }
12
- /**
13
- * Robust anchor record for reliable DOM element re-location.
14
- *
15
- * Survives:
16
- * - Page reloads
17
- * - Framework re-renders (React, Vue, Angular)
18
- * - Dynamic ID changes
19
- * - Minor DOM restructuring
20
- *
21
- * Does not survive:
22
- * - Major redesigns
23
- * - Content reordering (sort, filter)
24
- * - Element removal
25
- *
26
- * **Resolution Strategy (priority order):**
27
- * 1. id (90) - Stable, non-dynamic ID
28
- * 2. css (80/60) - Attribute selector
29
- * 3. robustXPath (50) - Attribute-based path
30
- * 4. containerHints (40) - Scoped search
31
- * 5. xPath variants (32-28) - Structural fallback
32
- * 6. contentHash (15) - Hash-based scan
33
- *
34
- * **Validation boosts:** tagName (+10), contentHash (+30)
35
- *
36
- * **Security:** No plaintext storage, MD5 hash only.
37
- */
38
- export interface AnchorRecord {
39
- /** Schema version (current: "1.0") */
40
- version: '1.0';
41
- /**
42
- * Stable element ID (non-dynamic only).
43
- *
44
- * Excluded patterns:
45
- * - yui_* (YUI framework)
46
- */
47
- id?: string;
48
- /** Tag name (uppercase, e.g., 'DIV', 'BUTTON') */
49
- tagName: string;
50
- /**
51
- * CSS selector from stable attributes.
52
- *
53
- * Example: `[data-testid='submit-btn'][role='button']`
54
- */
55
- elementSelector?: string;
56
- /**
57
- * XPath variants (in order of stability):
58
- *
59
- * 1. robustXPath - Attribute-based (MOST STABLE)
60
- * - Prioritizes: data-* > role > stable ID > aria-* > position
61
- * - Example: `//div[@role='main']/.../li[5]/span`
62
- * - Ignores dynamic IDs
63
- * - Stops at landmarks (main, nav, etc.)
64
- *
65
- * 2. xPath - Basic XPath (uses IDs when available)
66
- * 3. cfXPath - Positional with class hints
67
- * 4. fXPath - Pure positional (most fragile)
68
- */
69
- robustXPath?: string;
70
- xPath?: string;
71
- fXPath?: string;
72
- cfXPath?: string;
73
- /**
74
- * Content hash for secure validation.
75
- */
76
- contentHash?: ContentHash;
77
- /** Creation timestamp (milliseconds since epoch) */
78
- createdAt?: number;
79
- /** Parent element anchor record */
80
- parent?: AnchorRecord;
81
- }
82
- /**
83
- * Result of anchor resolution.
84
- */
85
- export interface AnchorResolution {
86
- /** Resolved element (null if not found) */
87
- element: Element | null;
88
- /**
89
- * Resolution method used.
90
- * Values: 'id', 'css', 'robustXPath', 'xPath', 'cfXPath', 'fXPath', 'contentHash', 'ancestor+tag'
91
- */
92
- matchedBy?: string;
93
- /**
94
- * Confidence score (0-120+).
95
- *
96
- * - 90+: High (unique ID)
97
- * - 80-89: Good (unique CSS, stable attributes)
98
- * - 40-79: Moderate (scoped search, multiple candidates)
99
- * - 15-39: Low (XPath, hash-based fallback)
100
- */
101
- score?: number;
102
- /**
103
- * Score breakdown.
104
- */
105
- scoreBreakdown?: {
106
- method: string;
107
- score: number;
108
- }[];
109
- }
@@ -1,51 +0,0 @@
1
- import { AnnotationProperty } from "./annotation-property.data.model";
2
- import { CursorPosition } from "./cursor-position.data.model";
3
- import { Location } from "./location.model";
4
- import { PageInfo } from "./page-info.model";
5
- import { TargetElement } from "./target-element.data.model";
6
- import { User } from "./user.data.model";
7
- export declare class ArrowAnnotation {
8
- /**
9
- * Unique identifier for the arrow pin annotation.
10
- *
11
- * Auto generated.
12
- */
13
- annotationId: string;
14
- /**
15
- * The user who created this arrow pin annotation.
16
- *
17
- */
18
- from: User;
19
- /**
20
- * Color used for the arrow pin annotation.
21
- *
22
- */
23
- color?: string;
24
- /**
25
- * Timestamp when the arrow annotation was last updated.
26
- *
27
- * Auto generated.
28
- */
29
- lastUpdated?: any;
30
- /**
31
- * Target element of attached annotation.
32
- */
33
- targetElement?: TargetElement | null;
34
- position?: CursorPosition | null;
35
- /**
36
- * Unique location id generated from provided location
37
- */
38
- locationId?: number | null;
39
- /**
40
- * Set location to identify user on sub document
41
- */
42
- location?: Location | null;
43
- type?: string;
44
- props: AnnotationProperty;
45
- /**
46
- * To maintain index of current annotation in available list of annotations
47
- * It will start from 1, so no need to add 1 in that.
48
- */
49
- annotationIndex?: number;
50
- pageInfo?: PageInfo;
51
- }
@@ -1,52 +0,0 @@
1
- import { ResolverActions } from "../../utils/enums";
2
- import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
3
- export interface AttachmentDataProvider {
4
- save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
5
- delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
6
- config?: ResolverConfig;
7
- }
8
- export interface DeleteAttachmentResolverRequest {
9
- attachmentId: number;
10
- metadata?: AttachmentResolverMetadata;
11
- event?: ResolverActions;
12
- }
13
- export interface SaveAttachmentResolverRequest {
14
- attachment: ResolverAttachment;
15
- metadata?: AttachmentResolverMetadata;
16
- event?: ResolverActions;
17
- }
18
- export interface PartialAttachment {
19
- url: string;
20
- name: string;
21
- attachmentId: number;
22
- }
23
- export interface ResolverAttachment {
24
- attachmentId: number;
25
- /**
26
- * File to be uploaded
27
- */
28
- file: File;
29
- /**
30
- * File name
31
- */
32
- name?: string;
33
- /**
34
- * Metadata of an attachment
35
- */
36
- metadata?: AttachmentResolverMetadata;
37
- /**
38
- * Mime type of an attachment
39
- */
40
- mimeType?: string;
41
- }
42
- export interface AttachmentResolverMetadata {
43
- organizationId: string | null;
44
- documentId: string | null;
45
- folderId?: string | null;
46
- attachmentId: number | null;
47
- commentAnnotationId: string | null;
48
- apiKey: string | null;
49
- }
50
- export interface SaveAttachmentResolverData {
51
- url: string;
52
- }
@@ -1,51 +0,0 @@
1
- import { OrganizationUserGroup } from "./organization-groups.data.model";
2
- import { UserContact } from "./user-contact.data.model";
3
- export declare class AutocompleteDataMap {
4
- [hotkey: string]: AutocompleteData;
5
- }
6
- export declare class AutocompleteData {
7
- hotkey: string;
8
- description?: string;
9
- type: 'custom' | 'contact' | 'group';
10
- data: AutocompleteItem[];
11
- groups?: AutocompleteGroup[];
12
- }
13
- export declare class AutocompleteItem {
14
- id: string;
15
- name: string;
16
- description?: string;
17
- icon?: {
18
- url?: string;
19
- svg?: string;
20
- };
21
- link?: string;
22
- groupId?: string;
23
- }
24
- export declare class AutocompleteReplaceData {
25
- text: string;
26
- custom: AutocompleteItem;
27
- }
28
- export declare class AutocompleteGroupReplaceData {
29
- text: string;
30
- groupId: string;
31
- clientGroupId: string;
32
- group?: OrganizationUserGroup;
33
- }
34
- export declare class AutocompleteUserContactReplaceData {
35
- text: string;
36
- userId: string;
37
- contact?: UserContact;
38
- }
39
- export declare class AutocompleteGroup {
40
- id: string;
41
- name: string;
42
- }
43
- export declare class AutocompleteChipData extends AutocompleteItem {
44
- type: 'contact' | 'custom';
45
- }
46
- export declare class AutoCompleteScrollConfig {
47
- itemSize?: number;
48
- minBufferPx?: number;
49
- maxBufferPx?: number;
50
- templateCacheSize?: number;
51
- }
@@ -1,9 +0,0 @@
1
- export declare class BaseMetadata {
2
- apiKey?: string;
3
- documentId?: string;
4
- clientDocumentId?: string;
5
- organizationId?: string;
6
- clientOrganizationId?: string;
7
- folderId?: string;
8
- veltFolderId?: string;
9
- }
@@ -1,37 +0,0 @@
1
- import { CommentAnnotation } from "./comment-annotation.data.model";
2
- import { UnreadCommentsMap } from "./comment-utils.data.model";
3
- import { Comment } from "./comment.data.model";
4
- import { CustomFilters } from "./custom-filter.data.model";
5
- import { VeltEventMetadata } from "./event-metadata.data.model";
6
- import { Notification } from "./notification.model";
7
- export interface VeltButtonClickEvent extends VeltButtonData {
8
- buttonContext?: VeltButtonContext;
9
- metadata?: VeltEventMetadata;
10
- customFilters?: CustomFilters;
11
- data?: any;
12
- }
13
- export interface VeltButtonContext {
14
- type?: string;
15
- groupId?: string;
16
- selections?: VeltButtonSelectionMap;
17
- clickedButtonId?: string;
18
- }
19
- export interface VeltButtonData {
20
- commentAnnotation?: CommentAnnotation;
21
- comment?: Comment;
22
- index?: number;
23
- commentAnnotations?: CommentAnnotation[];
24
- systemFilteredAnnotations?: CommentAnnotation[];
25
- unreadCommentAnnotationsMap?: UnreadCommentsMap;
26
- notification?: Notification;
27
- notifications?: Notification[];
28
- }
29
- export interface VeltButtonSelectionMap {
30
- [groupId: string]: {
31
- [buttonId: string]: boolean;
32
- };
33
- }
34
- export interface VeltResetButtonStateConfig {
35
- id?: string;
36
- group?: string;
37
- }
@@ -1,190 +0,0 @@
1
- import { CommentAccessMode } from "../../utils/enums";
2
- import { Attachment } from "./attachment.model";
3
- import { CommentAnnotation } from "./comment-annotation.data.model";
4
- import { Comment } from "./comment.data.model";
5
- import { CustomPriority, CustomStatus } from "./custom-filter.data.model";
6
- import { ReactionItem } from "./reaction-annotation.data.model";
7
- import { UserContact } from "./user-contact.data.model";
8
- import { User } from "./user.data.model";
9
- export interface RequestOptions {
10
- organizationId?: string;
11
- documentId?: string;
12
- folderId?: string;
13
- filters?: any;
14
- documentIds?: string[];
15
- allDocuments?: boolean;
16
- }
17
- export interface UpdatePriorityRequest {
18
- annotationId: string;
19
- priority?: CustomPriority;
20
- options?: RequestOptions;
21
- }
22
- export interface UpdateStatusRequest {
23
- annotationId: string;
24
- status: CustomStatus;
25
- options?: RequestOptions;
26
- }
27
- export interface UpdateAccessRequest {
28
- annotationId: string;
29
- accessMode: CommentAccessMode;
30
- options?: RequestOptions;
31
- }
32
- export interface ResolveCommentAnnotationRequest {
33
- annotationId: string;
34
- options?: RequestOptions;
35
- }
36
- export interface GetLinkRequest {
37
- annotationId: string;
38
- options?: RequestOptions;
39
- }
40
- export interface CopyLinkRequest {
41
- annotationId: string;
42
- options?: RequestOptions;
43
- }
44
- export interface AddCommentAnnotationRequest {
45
- annotation: CommentAnnotation;
46
- options?: RequestOptions;
47
- }
48
- export interface ApproveCommentAnnotationRequest {
49
- annotationId: string;
50
- options?: RequestOptions;
51
- }
52
- export interface AcceptCommentAnnotationRequest {
53
- annotationId: string;
54
- options?: RequestOptions;
55
- }
56
- export interface RejectCommentAnnotationRequest {
57
- annotationId: string;
58
- options?: RequestOptions;
59
- }
60
- export interface DeleteCommentAnnotationRequest {
61
- annotationId: string;
62
- options?: RequestOptions;
63
- }
64
- export interface CommentRequestQuery {
65
- organizationId?: string;
66
- documentIds?: string[];
67
- locationIds?: string[];
68
- statusIds?: string[];
69
- folderId?: string;
70
- allDocuments?: boolean;
71
- locationId?: string;
72
- aggregateDocuments?: boolean;
73
- filterGhostComments?: boolean;
74
- }
75
- export interface SubscribeCommentAnnotationRequest {
76
- annotationId: string;
77
- options?: RequestOptions;
78
- }
79
- export interface UnsubscribeCommentAnnotationRequest {
80
- annotationId: string;
81
- options?: RequestOptions;
82
- }
83
- export interface AssignUserRequest {
84
- annotationId: string;
85
- assignedTo: UserContact;
86
- options?: RequestOptions;
87
- }
88
- export interface AddCommentRequest {
89
- annotationId: string;
90
- comment: Comment;
91
- assignedTo?: User;
92
- assigned?: boolean;
93
- options?: RequestOptions;
94
- }
95
- export interface UpdateCommentRequest {
96
- annotationId: string;
97
- comment: Comment;
98
- skipDeleteThreadConfirmation?: boolean;
99
- merge?: boolean;
100
- options?: RequestOptions;
101
- }
102
- export interface DeleteCommentRequest {
103
- annotationId: string;
104
- commentId: number;
105
- skipDeleteThreadConfirmation?: boolean;
106
- options?: RequestOptions;
107
- }
108
- export interface GetCommentRequest {
109
- annotationId: string;
110
- options?: RequestOptions;
111
- }
112
- export interface AddAttachmentRequest {
113
- annotationId: string;
114
- files: File[];
115
- options?: RequestOptions;
116
- }
117
- export interface AddAttachmentResponse {
118
- valid: boolean;
119
- file?: File;
120
- maxAllowedSize: number;
121
- error?: string;
122
- attachment?: Attachment;
123
- }
124
- export interface DeleteAttachmentRequest {
125
- annotationId: string;
126
- commentId: number;
127
- attachmentId: number;
128
- options?: RequestOptions;
129
- }
130
- export interface GetAttachmentRequest {
131
- annotationId: string;
132
- commentId: number;
133
- options?: RequestOptions;
134
- }
135
- export interface GetRecordingRequest {
136
- annotationId: string;
137
- commentId: number;
138
- options?: RequestOptions;
139
- }
140
- export interface DeleteRecordingRequest {
141
- annotationId: string;
142
- commentId: number;
143
- recorderId: string;
144
- options?: RequestOptions;
145
- }
146
- export interface AddReactionRequest {
147
- annotationId: string;
148
- commentId: number;
149
- reaction: {
150
- reactionId: string;
151
- customReaction?: ReactionItem;
152
- };
153
- options?: RequestOptions;
154
- }
155
- export interface DeleteReactionRequest {
156
- annotationId: string;
157
- commentId: number;
158
- reaction: {
159
- reactionId: string;
160
- customReaction?: ReactionItem;
161
- };
162
- options?: RequestOptions;
163
- }
164
- export interface ToggleReactionRequest {
165
- annotationId: string;
166
- commentId: number;
167
- reaction: {
168
- reactionId: string;
169
- customReaction?: ReactionItem;
170
- };
171
- options?: RequestOptions;
172
- }
173
- export interface FetchCommentAnnotationsRequest {
174
- createdAfter?: number;
175
- createdBefore?: number;
176
- updatedAfter?: number;
177
- updatedBefore?: number;
178
- statusIds?: string[];
179
- order?: 'asc' | 'desc';
180
- pageToken?: string;
181
- allDocuments?: boolean;
182
- pageSize?: number;
183
- organizationId?: string;
184
- locationId?: string;
185
- documentIds?: string[];
186
- folderId?: string;
187
- resolvedBy?: string;
188
- userIds?: string[];
189
- mentionedUserIds?: string[];
190
- }