@veltdev/types-dev 5.0.2-beta.28 → 5.0.2-beta.3

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 (28) hide show
  1. package/app/client/snippyly.model.d.ts +1 -10
  2. package/app/models/data/attachment-resolver.data.model.d.ts +2 -2
  3. package/app/models/data/attachment.model.d.ts +0 -1
  4. package/app/models/data/autocomplete.data.model.d.ts +3 -3
  5. package/app/models/data/base-metadata.data.model.d.ts +0 -3
  6. package/app/models/data/comment-actions.data.model.d.ts +0 -4
  7. package/app/models/data/comment-annotation.data.model.d.ts +3 -11
  8. package/app/models/data/comment-events.data.model.d.ts +4 -17
  9. package/app/models/data/comment-resolver.data.model.d.ts +3 -3
  10. package/app/models/data/config.data.model.d.ts +0 -5
  11. package/app/models/data/core-events.data.model.d.ts +1 -32
  12. package/app/models/data/crdt.data.model.d.ts +0 -51
  13. package/app/models/data/live-state-events.data.model.d.ts +0 -6
  14. package/app/models/data/provider.data.model.d.ts +1 -4
  15. package/app/models/data/reaction-resolver.data.model.d.ts +3 -3
  16. package/app/models/data/recorder-annotation.data.model.d.ts +0 -11
  17. package/app/models/data/resolver.data.model.d.ts +0 -1
  18. package/app/models/data/user-resolver.data.model.d.ts +1 -15
  19. package/app/models/element/comment-element.model.d.ts +0 -20
  20. package/app/models/element/crdt-element.model.d.ts +1 -88
  21. package/app/utils/constants.d.ts +0 -31
  22. package/app/utils/enums.d.ts +4 -22
  23. package/models.d.ts +0 -2
  24. package/package.json +1 -1
  25. package/types.d.ts +0 -1
  26. package/app/models/data/activity.data.model.d.ts +0 -177
  27. package/app/models/data/recorder-resolver.data.model.d.ts +0 -58
  28. package/app/models/element/activity-element.model.d.ts +0 -33
@@ -5,7 +5,6 @@ import { DocumentUser } from "../models/data/document-user.data.model";
5
5
  import { Location } from "../models/data/location.model";
6
6
  import { User, UserOptions, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
7
7
  import { CustomCss } from "../models/data/custom-css.data.model";
8
- import { ActivityElement } from "../models/element/activity-element.model";
9
8
  import { AreaElement } from "../models/element/area-element.model";
10
9
  import { ArrowElement } from "../models/element/arrow-element.model";
11
10
  import { CommentElement } from "../models/element/comment-element.model";
@@ -30,7 +29,7 @@ import { VeltEventMetadata, VeltDebugInfo } from "../models/data/event-metadata.
30
29
  import { CoreEventTypesMap } from "../models/data/core-events.data.model";
31
30
  import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } from "../models/data/document.data.model";
32
31
  import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
33
- import { AnonymousUserDataProvider, UserDataProvider, GetUserPermissionsRequest, GetUserPermissionsResponse } from "../models/data/user-resolver.data.model";
32
+ import { UserDataProvider, GetUserPermissionsRequest, GetUserPermissionsResponse } from "../models/data/user-resolver.data.model";
34
33
  import { VeltDataProvider } from "../models/data/provider.data.model";
35
34
  import { VeltEncryptionProvider } from "../models/data/encryption-provider.data.model";
36
35
  import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
@@ -98,10 +97,6 @@ export declare class Snippyly {
98
97
  * To set the user data provider.
99
98
  */
100
99
  setUserDataProvider: (userDataProvider: UserDataProvider) => void;
101
- /**
102
- * To set the anonymous user data provider.
103
- */
104
- setAnonymousUserDataProvider: (resolver: AnonymousUserDataProvider, config?: { ha?: boolean }) => void;
105
100
  /**
106
101
  * To set the data provider.
107
102
  */
@@ -233,10 +228,6 @@ export declare class Snippyly {
233
228
  * Get the Autocomplete Object.
234
229
  */
235
230
  getAutocompleteElement: () => AutocompleteElement;
236
- /**
237
- * Get the Activity Element Object.
238
- */
239
- getActivityElement: () => ActivityElement;
240
231
  /**
241
232
  * Get the Area Object.
242
233
  */
@@ -1,8 +1,8 @@
1
1
  import { ResolverActions } from "../../utils/enums";
2
2
  import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
3
3
  export interface AttachmentDataProvider {
4
- save?: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
5
- delete?: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
4
+ save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
5
+ delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
6
6
  config?: ResolverConfig;
7
7
  }
8
8
  export interface DeleteAttachmentResolverRequest {
@@ -53,7 +53,6 @@ export interface UploadFileOptions {
53
53
  file: File;
54
54
  useAttachmentResolver?: boolean;
55
55
  metadata?: any;
56
- attachmentScope?: string;
57
56
  }
58
57
  export interface UploadFileData {
59
58
  files: File[];
@@ -22,17 +22,17 @@ export declare class AutocompleteItem {
22
22
  groupId?: string;
23
23
  }
24
24
  export declare class AutocompleteReplaceData {
25
- text?: string;
25
+ text: string;
26
26
  custom: AutocompleteItem;
27
27
  }
28
28
  export declare class AutocompleteGroupReplaceData {
29
- text?: string;
29
+ text: string;
30
30
  groupId: string;
31
31
  clientGroupId: string;
32
32
  group?: OrganizationUserGroup;
33
33
  }
34
34
  export declare class AutocompleteUserContactReplaceData {
35
- text?: string;
35
+ text: string;
36
36
  userId: string;
37
37
  contact?: UserContact;
38
38
  }
@@ -1,4 +1,3 @@
1
- import { DocumentMetadata } from './document-metadata.model';
2
1
  export declare class BaseMetadata {
3
2
  apiKey?: string;
4
3
  documentId?: string;
@@ -7,6 +6,4 @@ export declare class BaseMetadata {
7
6
  clientOrganizationId?: string;
8
7
  folderId?: string;
9
8
  veltFolderId?: string;
10
- documentMetadata?: DocumentMetadata;
11
- sdkVersion?: string | null;
12
9
  }
@@ -125,8 +125,6 @@ export interface CommentRequestQuery {
125
125
  batchedPerDocument?: boolean;
126
126
  /** Debounce time in ms for batchedPerDocument mode (default: 5000). */
127
127
  debounceMs?: number;
128
- /** Filter annotations by agent fields. Matches annotations where `agent.agentFields` array contains any of the provided values. */
129
- agentFields?: string[];
130
128
  }
131
129
  export interface SubscribeCommentAnnotationRequest {
132
130
  annotationId: string;
@@ -147,8 +145,6 @@ export interface AddCommentRequest {
147
145
  assignedTo?: User;
148
146
  assigned?: boolean;
149
147
  options?: RequestOptions;
150
- /** Optional visibility configuration for the comment */
151
- visibility?: CommentVisibilityConfig;
152
148
  }
153
149
  export interface UpdateCommentRequest {
154
150
  annotationId: string;
@@ -1,6 +1,5 @@
1
- import { CommentAccessMode, CommentVisibilityOptionType } from "../../utils/enums";
1
+ import { CommentAccessMode } from "../../utils/enums";
2
2
  import { BaseMetadata } from "./base-metadata.data.model";
3
- import { CommentVisibilityType } from "./comment-actions.data.model";
4
3
  import { Comment } from "./comment.data.model";
5
4
  import { CursorPosition } from "./cursor-position.data.model";
6
5
  import { CustomAnnotationDropdownItem } from "./custom-chip-dropdown.data.model";
@@ -11,11 +10,6 @@ import { TargetElement } from "./target-element.data.model";
11
10
  import { TargetTextRange } from "./target-text-range.data.model";
12
11
  import { User } from "./user.data.model";
13
12
  import { CommentAnnotationViews } from "./views.data.model";
14
- export interface CommentAnnotationVisibilityConfig {
15
- type: CommentVisibilityType;
16
- organizationId?: string;
17
- userIds?: string[];
18
- }
19
13
  export declare class CommentAnnotation {
20
14
  /**
21
15
  * Unique identifier for the comment pin annotation.
@@ -29,7 +23,6 @@ export declare class CommentAnnotation {
29
23
  * Auto generated.
30
24
  */
31
25
  annotationNumber?: number;
32
- visibilityConfig?: CommentAnnotationVisibilityConfig;
33
26
  /**
34
27
  * This is the list of all comments part of this annotation.
35
28
  *
@@ -239,10 +232,9 @@ export declare class CommentSelectionChangeData {
239
232
  selected: boolean;
240
233
  annotation: CommentAnnotation;
241
234
  }
242
- export declare class VisibilityOptionClickedData {
235
+ export declare class LocationClickedData {
243
236
  annotationId: string;
244
- visibility: CommentVisibilityOptionType;
245
- users?: any[];
237
+ location: 'public' | 'private';
246
238
  }
247
239
  export declare class InlineCommentSectionConfig {
248
240
  id: string;
@@ -1,4 +1,4 @@
1
- import { AssignToType, CommentAccessMode, CommentEventTypes, CommentStatus, CommentVisibilityOptionType } from "../../utils/enums";
1
+ import { AssignToType, CommentAccessMode, CommentEventTypes, CommentStatus } from "../../utils/enums";
2
2
  import { Attachment } from "./attachment.model";
3
3
  import { VeltButtonClickEvent } from "./button.data.model";
4
4
  import { AddAttachmentResponse } from "./comment-actions.data.model";
@@ -85,13 +85,10 @@ export type CommentEventTypesMap = {
85
85
  [CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
86
86
  [CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
87
87
  [CommentEventTypes.COMMENT_TOOL_CLICK]: CommentToolClickEvent;
88
- [CommentEventTypes.COMMENT_TOOL_CLICKED]: CommentToolClickedEvent;
89
88
  [CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
90
- [CommentEventTypes.SIDEBAR_BUTTON_CLICKED]: SidebarButtonClickedEvent;
91
89
  [CommentEventTypes.ATTACHMENT_DOWNLOAD_CLICKED]: AttachmentDownloadClickedEvent;
92
90
  [CommentEventTypes.COMMENT_SAVED]: CommentSavedEvent;
93
- [CommentEventTypes.COMMENT_SAVE_TRIGGERED]: CommentSaveTriggeredEvent;
94
- [CommentEventTypes.VISIBILITY_OPTION_CLICKED]: VisibilityOptionClickedEvent;
91
+ [CommentEventTypes.LOCATION_CLICKED]: LocationClickedEvent;
95
92
  };
96
93
  export interface AddAttachmentEvent {
97
94
  annotationId: string;
@@ -191,11 +188,6 @@ export interface CommentSavedEvent {
191
188
  commentAnnotation: CommentAnnotation;
192
189
  metadata: VeltEventMetadata;
193
190
  }
194
- export interface CommentSaveTriggeredEvent {
195
- annotationId: string;
196
- commentAnnotation: CommentAnnotation;
197
- metadata: VeltEventMetadata;
198
- }
199
191
  export interface UpdateCommentEvent {
200
192
  annotationId: string;
201
193
  commentAnnotation: CommentAnnotation;
@@ -322,23 +314,18 @@ export interface CommentToolClickEvent {
322
314
  targetElementId?: string | null;
323
315
  metadata?: VeltEventMetadata;
324
316
  }
325
- export interface CommentToolClickedEvent extends CommentToolClickEvent {
326
- }
327
317
  export interface SidebarButtonClickEvent {
328
318
  metadata?: VeltEventMetadata;
329
319
  }
330
- export interface SidebarButtonClickedEvent extends SidebarButtonClickEvent {
331
- }
332
320
  export interface AttachmentDownloadClickedEvent {
333
321
  annotationId: string;
334
322
  commentAnnotation: CommentAnnotation;
335
323
  attachment: Attachment;
336
324
  metadata?: VeltEventMetadata;
337
325
  }
338
- export interface VisibilityOptionClickedEvent {
326
+ export interface LocationClickedEvent {
339
327
  annotationId: string;
340
328
  commentAnnotation: CommentAnnotation;
341
- visibility: CommentVisibilityOptionType;
342
- users?: any[];
329
+ location: 'public' | 'private';
343
330
  metadata?: VeltEventMetadata;
344
331
  }
@@ -4,9 +4,9 @@ import { BaseMetadata } from "./base-metadata.data.model";
4
4
  import { CommentAnnotation } from "./comment-annotation.data.model";
5
5
  import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
6
6
  export interface CommentAnnotationDataProvider {
7
- get?: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
8
- save?: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
9
- delete?: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
7
+ get: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
8
+ save: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
9
+ delete: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
10
10
  config?: ResolverConfig;
11
11
  }
12
12
  export interface GetCommentResolverRequest {
@@ -76,9 +76,4 @@ export interface DisableLogsConfig {
76
76
  }
77
77
  export interface GetProjectConfigResponse {
78
78
  isPrivateCommentsEnabled: boolean;
79
- activityConfig?: ActivityConfig;
80
- }
81
- export interface ActivityConfig {
82
- immutable: boolean;
83
- isEnabled: boolean;
84
79
  }
@@ -7,7 +7,6 @@ export type CoreEventTypesMap = {
7
7
  [CoreEventTypes.COMMENT_RESOLVER]: CommentResolverEvent;
8
8
  [CoreEventTypes.ATTACHMENT_RESOLVER]: AttachmentResolverEvent;
9
9
  [CoreEventTypes.REACTION_RESOLVER]: ReactionResolverEvent;
10
- [CoreEventTypes.RECORDER_RESOLVER]: RecorderResolverEvent;
11
10
  [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
12
11
  [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
13
12
  [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
@@ -24,8 +23,7 @@ export declare enum UserResolverSource {
24
23
  SET_SINGLE_EDITOR_MODE_LIVE_STATE_DATA_FOR_DIFFERENT_USER_PRESENT_ON_TAB = "setSingleEditorModeLiveStateDataForDifferentUserPresentOnTab",
25
24
  RESOLVE_AND_MERGE_SINGLE_EDITOR_LIVE_STATE_DATA_WITH_USER = "resolveAndMergeSingleEditorLiveStateDataWithUser",
26
25
  GET_SINGLE_EDITOR_MODE_DATA = "getSingleEditorModeData",
27
- RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages",
28
- RESOLVE_USER_IDS_BY_EMAIL = "resolveUserIdsByEmail"
26
+ RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages"
29
27
  }
30
28
  export declare enum UserResolverModuleName {
31
29
  IDENTIFY = "identify/authProvider",
@@ -148,35 +146,6 @@ export type ReactionResolverEventType = {
148
146
  REACTION_DELETE_RESULT: 'reactionDeleteResult';
149
147
  REACTION_DELETE_ERROR: 'reactionDeleteError';
150
148
  };
151
- export declare enum RecorderResolverSource {
152
- RESOLVE_RECORDER_ANNOTATIONS = "resolveRecorderAnnotations",
153
- SAVE_RECORDER_ANNOTATION = "saveRecorderAnnotation",
154
- DELETE_RECORDER_ANNOTATION = "deleteRecorderAnnotation",
155
- FORMAT_RESPONSE = "formatResponse",
156
- INIT_DOCUMENTS = "initDocuments",
157
- SET_DATA = "setData",
158
- UPDATE_DATA = "updateData",
159
- DELETE_DATA = "deleteData"
160
- }
161
- export declare enum RecorderResolverModuleName {
162
- GET_RECORDER_ANNOTATIONS = "getRecorderAnnotations"
163
- }
164
- export type RecorderResolverEvent = BaseResolverEvent<RecorderResolverEventType, RecorderResolverSource, RecorderResolverModuleName>;
165
- export type RecorderResolverEventType = {
166
- RECORDER_RESOLUTION_REQUEST_FORMED: 'recorderResolutionRequestFormed';
167
- RECORDER_RESOLUTION_REQUEST_TRIGGERED: 'recorderResolutionRequestTriggered';
168
- RECORDER_RESOLUTION_RESULT: 'recorderResolutionResult';
169
- RECORDER_RESOLUTION_ERROR: 'recorderResolutionError';
170
- RECORDER_RESOLUTION_RESULT_FROM_CACHE: 'recorderResolutionResultFromCache';
171
- RECORDER_SAVE_REQUEST_FORMED: 'recorderSaveRequestFormed';
172
- RECORDER_SAVE_REQUEST_TRIGGERED: 'recorderSaveRequestTriggered';
173
- RECORDER_SAVE_RESULT: 'recorderSaveResult';
174
- RECORDER_SAVE_ERROR: 'recorderSaveError';
175
- RECORDER_DELETE_REQUEST_FORMED: 'recorderDeleteRequestFormed';
176
- RECORDER_DELETE_REQUEST_TRIGGERED: 'recorderDeleteRequestTriggered';
177
- RECORDER_DELETE_RESULT: 'recorderDeleteResult';
178
- RECORDER_DELETE_ERROR: 'recorderDeleteError';
179
- };
180
149
  export type ErrorEvent = {
181
150
  event?: string;
182
151
  sourceMethod?: string;
@@ -58,54 +58,3 @@ export interface CrdtDeleteVersionQuery {
58
58
  id: string;
59
59
  versionId: string;
60
60
  }
61
- export interface CrdtPushMessageQuery {
62
- id: string;
63
- data: number[];
64
- yjsClientId: number;
65
- messageType?: 'sync' | 'awareness';
66
- /** User-facing value for event emission only (not stored in database) */
67
- eventData?: unknown;
68
- /** Yjs data type: 'text' | 'map' | 'array' | 'xml' | 'xmltext' */
69
- type?: string;
70
- /** Content key used in Y.Doc shared types */
71
- contentKey?: string;
72
- /** Editor/library source: 'tiptap', 'plate', 'codemirror', etc. */
73
- source?: string;
74
- }
75
- export interface CrdtOnMessageQuery {
76
- id: string;
77
- callback: (message: CrdtMessageData) => void;
78
- afterTs?: number;
79
- }
80
- export interface CrdtMessageData {
81
- data: number[];
82
- yjsClientId: number;
83
- timestamp: number;
84
- }
85
- export interface CrdtSnapshotData {
86
- state?: Uint8Array | number[];
87
- vector?: Uint8Array | number[];
88
- timestamp?: number;
89
- }
90
- export interface CrdtGetSnapshotQuery {
91
- id: string;
92
- }
93
- export interface CrdtSaveSnapshotQuery {
94
- id: string;
95
- state: Uint8Array | number[];
96
- vector: Uint8Array | number[];
97
- /** Yjs data type: 'text' | 'map' | 'array' | 'xml' | 'xmltext' */
98
- type?: string;
99
- /** Content key used in Y.Doc shared types */
100
- contentKey?: string;
101
- /** Editor/library source: 'tiptap', 'plate', 'codemirror', etc. */
102
- source?: string;
103
- }
104
- export interface CrdtGetMessagesQuery {
105
- id: string;
106
- afterTs?: number;
107
- }
108
- export interface CrdtPruneMessagesQuery {
109
- id: string;
110
- beforeTs: number;
111
- }
@@ -5,18 +5,12 @@ export interface AccessRequestEvent {
5
5
  editor?: User;
6
6
  timestamp?: number;
7
7
  status?: string;
8
- totalUsers?: number;
9
- presenceSnippylyUserIds?: string[];
10
- presenceClientUserIds?: string[];
11
8
  }
12
9
  export interface SEMEvent {
13
10
  viewer?: User;
14
11
  editor?: User;
15
12
  timestamp?: number;
16
13
  role?: string;
17
- totalUsers?: number;
18
- presenceSnippylyUserIds?: string[];
19
- presenceClientUserIds?: string[];
20
14
  }
21
15
  export type LiveStateEventTypesMap = {
22
16
  [LiveStateSyncEventTypes.ACCESS_REQUESTED]: AccessRequestEvent;
@@ -1,13 +1,10 @@
1
1
  import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
2
2
  import { AttachmentDataProvider } from "./attachment-resolver.data.model";
3
3
  import { ReactionAnnotationDataProvider } from "./reaction-resolver.data.model";
4
- import { RecorderAnnotationDataProvider } from "./recorder-resolver.data.model";
5
- import { AnonymousUserDataProvider, UserDataProvider } from "./user-resolver.data.model";
4
+ import { UserDataProvider } from "./user-resolver.data.model";
6
5
  export interface VeltDataProvider {
7
6
  comment?: CommentAnnotationDataProvider;
8
7
  user?: UserDataProvider;
9
8
  reaction?: ReactionAnnotationDataProvider;
10
9
  attachment?: AttachmentDataProvider;
11
- anonymousUser?: AnonymousUserDataProvider;
12
- recorder?: RecorderAnnotationDataProvider;
13
10
  }
@@ -4,9 +4,9 @@ import { PartialUser } from "./comment-resolver.data.model";
4
4
  import { ReactionAnnotation } from "./reaction-annotation.data.model";
5
5
  import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
6
6
  export interface ReactionAnnotationDataProvider {
7
- get?: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
8
- save?: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
9
- delete?: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
7
+ get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
8
+ save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
9
+ delete: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
10
10
  config?: ResolverConfig;
11
11
  }
12
12
  export interface GetReactionResolverRequest {
@@ -150,17 +150,6 @@ export declare class RecorderAnnotation {
150
150
  chunkUrls?: {
151
151
  [key: number]: string;
152
152
  };
153
- /**
154
- * Whether the recorder resolver is used for this annotation.
155
- * Used by UI components to show loading states while resolver data is being fetched.
156
- */
157
- isRecorderResolverUsed?: boolean;
158
- /**
159
- * Whether the real recording URL is available.
160
- * Set to false when the annotation is first saved (URL is still a local blob),
161
- * and true once the actual URL from storage is available after the async upload completes.
162
- */
163
- isUrlAvailable?: boolean;
164
153
  }
165
154
  export interface RecorderAnnotationEditVersion {
166
155
  from?: User;
@@ -9,7 +9,6 @@ export interface ResolverConfig {
9
9
  getRetryConfig?: RetryConfig;
10
10
  resolveUsersConfig?: ResolveUsersConfig;
11
11
  fieldsToRemove?: string[];
12
- additionalFields?: string[];
13
12
  getConfig?: ResolverEndpointConfig;
14
13
  saveConfig?: ResolverEndpointConfig;
15
14
  deleteConfig?: ResolverEndpointConfig;
@@ -1,24 +1,10 @@
1
- import { ResolverConfig, ResolverResponse, RetryConfig } from "./resolver.data.model";
1
+ import { ResolverConfig } from "./resolver.data.model";
2
2
  import { User } from "./user.data.model";
3
3
  export interface UserDataProvider {
4
4
  get(userIds: string[]): Promise<Record<string, User>>;
5
5
  config?: ResolverConfig;
6
6
  resolveTimeout?: number;
7
7
  }
8
- export interface AnonymousUserDataProvider {
9
- resolveUserIdsByEmail(request: ResolveUserIdsByEmailRequest): Promise<ResolverResponse<Record<string, string>>>;
10
- config?: AnonymousUserDataProviderConfig;
11
- }
12
- export interface AnonymousUserDataProviderConfig {
13
- resolveTimeout?: number;
14
- getRetryConfig?: RetryConfig;
15
- }
16
- export interface ResolveUserIdsByEmailRequest {
17
- organizationId: string;
18
- documentId?: string;
19
- folderId?: string;
20
- emails: string[];
21
- }
22
8
  export interface GetUserResolverRequest {
23
9
  organizationId: string;
24
10
  userIds: string[];
@@ -290,16 +290,6 @@ export declare class CommentElement {
290
290
  */
291
291
  public disableStatus: () => any;
292
292
 
293
- /**
294
- * To enable visibility options on comments
295
- */
296
- public enableVisibilityOptions: () => any;
297
-
298
- /**
299
- * To disable visibility options on comments
300
- */
301
- public disableVisibilityOptions: () => any;
302
-
303
293
  /**
304
294
  * To enable feature to show resolve button
305
295
  */
@@ -1630,16 +1620,6 @@ export declare class CommentElement {
1630
1620
  */
1631
1621
  private _disableStatus;
1632
1622
 
1633
- /**
1634
- * To enable visibility options on comments
1635
- */
1636
- private _enableVisibilityOptions;
1637
-
1638
- /**
1639
- * To disable visibility options on comments
1640
- */
1641
- private _disableVisibilityOptions;
1642
-
1643
1623
  /**
1644
1624
  * To enable feature to show resolve button
1645
1625
  */
@@ -1,5 +1,5 @@
1
1
  // @ts-nocheck
2
- import { CrdtGetDataQuery, CrdtGetMessagesQuery, CrdtGetSnapshotQuery, CrdtGetVersionQuery, CrdtGetVersionsQuery, CrdtMessageData, CrdtOnDataChangeQuery, CrdtOnMessageQuery, CrdtOnPresenceChangeQuery, CrdtOnRegisteredUserChangeQuery, CrdtOnStateChangeQuery, CrdtPruneMessagesQuery, CrdtPushMessageQuery, CrdtRegisterSyncUserQuery, CrdtSaveSnapshotQuery, CrdtSetPresenceQuery, CrdtSaveVersionQuery, CrdtSnapshotData, CrdtUpdateDataQuery, CrdtUpdateStateQuery } from "../data/crdt.data.model";
2
+ import { CrdtGetDataQuery, CrdtGetVersionQuery, CrdtOnDataChangeQuery, CrdtOnPresenceChangeQuery, CrdtOnRegisteredUserChangeQuery, CrdtOnStateChangeQuery, CrdtRegisterSyncUserQuery, CrdtSetPresenceQuery, CrdtSaveVersionQuery, CrdtUpdateDataQuery, CrdtUpdateStateQuery } from "../data/crdt.data.model";
3
3
  import { CrdtEventTypesMap } from "../data/crdt-events.data.model";
4
4
 
5
5
  export declare class CrdtElement {
@@ -80,12 +80,6 @@ export declare class CrdtElement {
80
80
  */
81
81
  getVersion: (getVersionQuery: CrdtGetVersionQuery) => Promise<any>;
82
82
 
83
- /**
84
- * Get all versions of a specific CRDT document
85
- * @param id Document ID
86
- */
87
- getVersions: (getVersionsQuery: CrdtGetVersionsQuery) => Promise<any>;
88
-
89
83
  /**
90
84
  * Enable webhook
91
85
  */
@@ -102,51 +96,6 @@ export declare class CrdtElement {
102
96
  */
103
97
  setWebhookDebounceTime: (time: number) => void;
104
98
 
105
- /**
106
- * Push a lib0-encoded message to the unified message stream.
107
- * Uses Firebase push() for chronologically-ordered keys.
108
- * Carries both sync (type 0) and awareness (type 1) messages.
109
- * @param pushMessageQuery - contains id, data (encoded bytes), yjsClientId (Y.Doc client ID), optional messageType and eventData
110
- */
111
- pushMessage: (pushMessageQuery: CrdtPushMessageQuery) => Promise<void>;
112
- /**
113
- * Subscribe to the unified message stream for real-time sync.
114
- * Emits each new message individually as it arrives (streaming pattern).
115
- * Returns an unsubscribe function.
116
- * @param onMessageQuery - contains id, callback, and optional afterTs for filtering
117
- */
118
- onMessage: (onMessageQuery: CrdtOnMessageQuery) => () => void;
119
- /**
120
- * Fetch all messages after a given timestamp (one-time read).
121
- * Used for message replay during initial load (y-redis pattern).
122
- * @param getMessagesQuery - contains id and optional afterTs
123
- */
124
- getMessages: (getMessagesQuery: CrdtGetMessagesQuery) => Promise<CrdtMessageData[]>;
125
- /**
126
- * Get the latest full-state snapshot for a document.
127
- * Used as the baseline for message replay during initial load.
128
- * @param getSnapshotQuery - contains id
129
- */
130
- getSnapshot: (getSnapshotQuery: CrdtGetSnapshotQuery) => Promise<CrdtSnapshotData | null>;
131
- /**
132
- * Save a full-state snapshot (state + vector) for fast initial load.
133
- * Called periodically to create checkpoints, enabling message pruning.
134
- * @param saveSnapshotQuery - contains id, state (Y.Doc update), and vector (state vector)
135
- */
136
- saveSnapshot: (saveSnapshotQuery: CrdtSaveSnapshotQuery) => Promise<void>;
137
- /**
138
- * Remove messages older than the given timestamp from the message stream.
139
- * Called after saving a snapshot to keep the message stream bounded.
140
- * @param pruneMessagesQuery - contains id and beforeTs
141
- */
142
- pruneMessages: (pruneMessagesQuery: CrdtPruneMessagesQuery) => Promise<void>;
143
-
144
- /**
145
- * To set activity debounce time for batching CRDT edits (Default value is 10 minutes)
146
- * @param time debounce time in milliseconds (minimum: 10 seconds)
147
- */
148
- setActivityDebounceTime: (time: number) => void;
149
-
150
99
  /**
151
100
  * Subscribe to crdt actions
152
101
  * @param action Action to subscribe to
@@ -239,36 +188,6 @@ export declare class CrdtElement {
239
188
  */
240
189
  private _getVersions;
241
190
 
242
- /**
243
- * Push a message to the unified message stream
244
- */
245
- private _pushMessage;
246
-
247
- /**
248
- * Subscribe to the unified message stream
249
- */
250
- private _onMessage;
251
-
252
- /**
253
- * Fetch all messages after a given timestamp
254
- */
255
- private _getMessages;
256
-
257
- /**
258
- * Get the latest snapshot for a document
259
- */
260
- private _getSnapshot;
261
-
262
- /**
263
- * Save a full-state snapshot
264
- */
265
- private _saveSnapshot;
266
-
267
- /**
268
- * Remove messages older than a given timestamp
269
- */
270
- private _pruneMessages;
271
-
272
191
  /**
273
192
  * Enable webhook
274
193
  */
@@ -285,12 +204,6 @@ export declare class CrdtElement {
285
204
  */
286
205
  private _setWebhookDebounceTime;
287
206
 
288
- /**
289
- * Set activity debounce time for batching CRDT edits
290
- * @param time debounce time in milliseconds (minimum: 10 seconds)
291
- */
292
- private _setActivityDebounceTime;
293
-
294
207
  /**
295
208
  * Subscribe to crdt actions
296
209
  * @param action Action to subscribe to
@@ -57,8 +57,6 @@ export declare class Constants {
57
57
  static FIREBASE_PARTIAL_PATH_NOTIFICATIONS: string;
58
58
  static FIREBASE_PARTIAL_PATH_ORGANIZATION_NOTIFICATIONS: string;
59
59
  static FIREBASE_PARTIAL_PATH_LAST_NOTIFICATION_TIMESTAMP: string;
60
- static FIREBASE_PARTIAL_PATH_ACTIVITIES: string;
61
- static FIREBASE_PARTIAL_PATH_LAST_ACTIVITY_TIMESTAMP: string;
62
60
  static FIREBASE_PARTIAL_PATH_HEARTBEAT: string;
63
61
  static FIREBASE_PARTIAL_PATH_HEARTBEAT_BY_DOCUMENT: string;
64
62
  static FIREBASE_PARTIAL_PATH_USERS: string;
@@ -246,36 +244,7 @@ export declare class Constants {
246
244
  VELT_NOTIFICATIONS_HISTORY_PANEL: string;
247
245
  VELT_WIREFRAME: string;
248
246
  VELT_AUTOCOMPLETE: string;
249
- VELT_AUTOCOMPLETE_PANEL: string;
250
- VELT_AUTOCOMPLETE_OPTION: string;
251
- VELT_AUTOCOMPLETE_OPTION_ICON: string;
252
- VELT_AUTOCOMPLETE_OPTION_NAME: string;
253
- VELT_AUTOCOMPLETE_OPTION_DESCRIPTION: string;
254
- VELT_AUTOCOMPLETE_OPTION_ERROR_ICON: string;
255
- VELT_AUTOCOMPLETE_GROUP_OPTION: string;
256
- VELT_AUTOCOMPLETE_TOOL: string;
257
- VELT_AUTOCOMPLETE_EMPTY: string;
258
247
  VELT_AUTOCOMPLETE_CHIP: string;
259
- VELT_AUTOCOMPLETE_CHIP_TOOLTIP: string;
260
- VELT_AUTOCOMPLETE_CHIP_TOOLTIP_ICON: string;
261
- VELT_AUTOCOMPLETE_CHIP_TOOLTIP_NAME: string;
262
- VELT_AUTOCOMPLETE_CHIP_TOOLTIP_DESCRIPTION: string;
263
- VELT_AUTOCOMPLETE_CONTEXT_WRAPPER: string;
264
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER: string;
265
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_ICON: string;
266
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_TEXT: string;
267
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN: string;
268
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER: string;
269
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_LABEL: string;
270
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_AVATAR_LIST: string;
271
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_AVATAR_LIST_ITEM: string;
272
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_AVATAR_LIST_REMAINING_COUNT: string;
273
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_ICON: string;
274
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT: string;
275
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_ITEM: string;
276
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_ITEM_ICON: string;
277
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_ITEM_LABEL: string;
278
- VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_USER_PICKER: string;
279
248
  VELT_COMMENT_COMPOSER: string;
280
249
  VELT_SKELETON_LOADER: string;
281
250
  VELT_SHADOW_DOM_INTERNAL: string;
@@ -26,10 +26,7 @@ export declare enum ResolverActions {
26
26
  REACTION_ADD = "reaction.add",
27
27
  REACTION_DELETE = "reaction.delete",
28
28
  ATTACHMENT_ADD = "attachment.add",
29
- ATTACHMENT_DELETE = "attachment.delete",
30
- RECORDER_ANNOTATION_ADD = "recorder_annotation.add",
31
- RECORDER_ANNOTATION_UPDATE = "recorder_annotation.update",
32
- RECORDER_ANNOTATION_DELETE = "recorder_annotation.delete"
29
+ ATTACHMENT_DELETE = "attachment.delete"
33
30
  }
34
31
  export declare const CommentEventTypes: {
35
32
  readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
@@ -65,13 +62,10 @@ export declare const CommentEventTypes: {
65
62
  readonly COMMENT_PIN_CLICKED: "commentPinClicked";
66
63
  readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
67
64
  readonly COMMENT_TOOL_CLICK: "commentToolClick";
68
- readonly COMMENT_TOOL_CLICKED: "commentToolClicked";
69
65
  readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
70
- readonly SIDEBAR_BUTTON_CLICKED: "sidebarButtonClicked";
71
66
  readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
72
67
  readonly COMMENT_SAVED: "commentSaved";
73
- readonly COMMENT_SAVE_TRIGGERED: "commentSaveTriggered";
74
- readonly VISIBILITY_OPTION_CLICKED: "visibilityOptionClicked";
68
+ readonly LOCATION_CLICKED: "locationClicked";
75
69
  };
76
70
  export declare const RecorderEventTypes: {
77
71
  readonly TRANSCRIPTION_DONE: "transcriptionDone";
@@ -92,7 +86,6 @@ export declare const CoreEventTypes: {
92
86
  readonly COMMENT_RESOLVER: "commentResolver";
93
87
  readonly ATTACHMENT_RESOLVER: "attachmentResolver";
94
88
  readonly REACTION_RESOLVER: "reactionResolver";
95
- readonly RECORDER_RESOLVER: "recorderResolver";
96
89
  readonly VELT_BUTTON_CLICK: "veltButtonClick";
97
90
  readonly USER_UPDATE: "userUpdate";
98
91
  readonly INIT_UPDATE: "initUpdate";
@@ -178,8 +171,7 @@ export declare enum Features {
178
171
  REWRITER = "rewriter",
179
172
  LIVE_SELECTION = "liveSelection",
180
173
  NOTIFICATION = "notification",
181
- REACTION = "reaction",
182
- ACTIVITY = "activity"
174
+ REACTION = "reaction"
183
175
  }
184
176
  export declare enum AnalyticsFeatures {
185
177
  AREA = "area",
@@ -201,7 +193,7 @@ export declare enum AnalyticsFeatures {
201
193
  INLINE_COMMENT = "inlineComment",
202
194
  COMMENT_SIDEBAR = "commentSidebar"
203
195
  }
204
- export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread' | 'activity';
196
+ export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
205
197
  export type AssignToType = 'dropdown' | 'checkbox';
206
198
  export declare enum DeviceType {
207
199
  DESKTOP = "Desktop",
@@ -320,13 +312,3 @@ export type NotificationSettingsItemType = 'ALL' | 'MINE' | 'NONE' | string;
320
312
  * Type for notification settings layout
321
313
  */
322
314
  export type NotificationSettingsLayout = 'accordion' | 'dropdown';
323
- /**
324
- * Enum for comment visibility options in the visibility banner dropdown
325
- */
326
- export declare enum CommentVisibilityOption {
327
- RESTRICTED_SELF = "restrictedSelf",
328
- RESTRICTED_SELECTED_PEOPLE = "restrictedSelectedPeople",
329
- ORGANIZATION_PRIVATE = "organizationPrivate",
330
- PUBLIC = "public"
331
- }
332
- export type CommentVisibilityOptionType = `${CommentVisibilityOption}`;
package/models.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  export * from './app/utils/enums';
2
2
  export * from './app/models/data/anchor-record.data.model';
3
3
  export * from './app/models/data/attachment.model';
4
- export * from './app/models/data/activity.data.model';
5
4
  export * from './app/models/data/area-annotation.data.model';
6
5
  export * from './app/models/data/arrow-annotation.data.model';
7
6
  export * from './app/models/data/base-metadata.data.model';
@@ -72,7 +71,6 @@ export * from './app/models/data/views.data.model';
72
71
  export * from './app/models/data/autocomplete.data.model';
73
72
  export * from './app/models/data/reaction-annotation.data.model';
74
73
  export * from './app/models/data/reaction-resolver.data.model';
75
- export * from './app/models/data/recorder-resolver.data.model';
76
74
  export * from './app/models/data/attachment-resolver.data.model';
77
75
  export * from './app/models/data/reaction.data.model';
78
76
  export * from './app/models/data/organization-groups.data.model';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/types-dev",
3
- "version": "5.0.2-beta.28",
3
+ "version": "5.0.2-beta.3",
4
4
  "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
5
5
  "homepage": "https://velt.dev",
6
6
  "keywords": [
package/types.d.ts CHANGED
@@ -17,5 +17,4 @@ export * from './app/models/element/notification-element.model';
17
17
  export * from './app/models/element/autocomplete-element.model';
18
18
  export * from './app/models/element/reaction-element.model';
19
19
  export * from './app/models/element/crdt-element.model';
20
- export * from './app/models/element/activity-element.model';
21
20
  export * from './models';
@@ -1,177 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { BaseMetadata } from './base-metadata.data.model';
3
- import { User } from './user.data.model';
4
- /**
5
- * Feature types that can generate activities.
6
- */
7
- export type ActivityFeatureType = 'comment' | 'reaction' | 'recorder' | 'crdt' | 'custom';
8
- /**
9
- * Comment action type constants following the `entity_type.action` naming pattern.
10
- * Annotation-level actions use `comment_annotation.*`, comment-level use `comment.*`.
11
- */
12
- export declare const CommentActivityActionTypes: {
13
- readonly ANNOTATION_ADD: "comment_annotation.add";
14
- readonly ANNOTATION_DELETE: "comment_annotation.delete";
15
- readonly COMMENT_ADD: "comment.add";
16
- readonly COMMENT_UPDATE: "comment.update";
17
- readonly COMMENT_DELETE: "comment.delete";
18
- readonly STATUS_CHANGE: "comment_annotation.status_change";
19
- readonly PRIORITY_CHANGE: "comment_annotation.priority_change";
20
- readonly ASSIGN: "comment_annotation.assign";
21
- readonly ACCESS_MODE_CHANGE: "comment_annotation.access_mode_change";
22
- readonly CUSTOM_LIST_CHANGE: "comment_annotation.custom_list_change";
23
- readonly APPROVE: "comment_annotation.approve";
24
- readonly ACCEPT: "comment.accept";
25
- readonly REJECT: "comment.reject";
26
- readonly REACTION_ADD: "comment.reaction_add";
27
- readonly REACTION_DELETE: "comment.reaction_delete";
28
- readonly SUBSCRIBE: "comment_annotation.subscribe";
29
- readonly UNSUBSCRIBE: "comment_annotation.unsubscribe";
30
- };
31
- export type CommentActivityActionType = typeof CommentActivityActionTypes[keyof typeof CommentActivityActionTypes];
32
- /**
33
- * Recorder action type constants following the `recording.*` naming pattern.
34
- */
35
- export declare const RecorderActivityActionTypes: {
36
- readonly RECORDING_ADD: "recording.add";
37
- readonly RECORDING_DELETE: "recording.delete";
38
- };
39
- export type RecorderActivityActionType = typeof RecorderActivityActionTypes[keyof typeof RecorderActivityActionTypes];
40
- /**
41
- * Reaction action type constants following the `reaction.*` naming pattern.
42
- */
43
- export declare const ReactionActivityActionTypes: {
44
- readonly REACTION_ADD: "reaction.add";
45
- readonly REACTION_DELETE: "reaction.delete";
46
- };
47
- export type ReactionActivityActionType = typeof ReactionActivityActionTypes[keyof typeof ReactionActivityActionTypes];
48
- /**
49
- * CRDT action type constants following the `crdt.*` naming pattern.
50
- */
51
- export declare const CrdtActivityActionTypes: {
52
- readonly EDITOR_EDIT: "crdt.editor_edit";
53
- };
54
- export type CrdtActivityActionType = typeof CrdtActivityActionTypes[keyof typeof CrdtActivityActionTypes];
55
- /**
56
- * Represents a single from/to change pair.
57
- * `from` is always present (null for 'added' events) for uniform structure.
58
- */
59
- export interface ActivityChange<T = unknown> {
60
- from?: T | null;
61
- to?: T | null;
62
- }
63
- /**
64
- * Dynamic change tracking. Keys are domain-specific (e.g., 'status', 'commentText', 'assignedTo').
65
- * No fixed keys — activities span multiple features.
66
- */
67
- export interface ActivityChanges {
68
- [key: string]: ActivityChange | undefined;
69
- }
70
- /**
71
- * Metadata for activity records. Extends BaseMetadata with denormalized IDs
72
- * for efficient querying at the organization level.
73
- */
74
- export declare class ActivityMetadata extends BaseMetadata {
75
- [key: string]: any;
76
- }
77
- /**
78
- * Core activity record representing a single activity event.
79
- *
80
- * @typeParam TEntity - Type of the parent entity snapshot (e.g., CommentAnnotation)
81
- * @typeParam TTarget - Type of the sub-entity snapshot (e.g., Comment)
82
- */
83
- export declare class ActivityRecord<TEntity = unknown, TTarget = unknown> {
84
- /** Auto-generated unique ID */
85
- id: string;
86
- /** Feature that generated this activity */
87
- featureType: ActivityFeatureType;
88
- /** Action that occurred, following `entity_type.action` pattern */
89
- actionType: string;
90
- /** Event type that occurred */
91
- eventType?: string;
92
- /** User who performed the action */
93
- actionUser: User;
94
- /** Server timestamp (set by backend) */
95
- timestamp: number;
96
- /** Denormalized IDs for querying */
97
- metadata: ActivityMetadata;
98
- /** ID of the parent entity (annotationId, recordingId, etc.) */
99
- targetEntityId: string;
100
- /** ID of the sub-entity acted on (commentId within annotation, null for entity-level actions) */
101
- targetSubEntityId?: string | null;
102
- /** Linear-style from/to change pairs */
103
- changes?: ActivityChanges;
104
- /** Full parent entity snapshot at time of action */
105
- entityData?: TEntity;
106
- /** Sub-entity snapshot (or user-provided data for custom activities) */
107
- entityTargetData?: TTarget;
108
- /** Display message template — ONLY for custom activities */
109
- displayMessageTemplate?: string;
110
- /** Template variable values — ONLY for custom activities */
111
- displayMessageTemplateData?: Record<string, unknown>;
112
- /** Computed display message (generated client-side, never stored in Firestore) */
113
- displayMessage?: string;
114
- /** Icon URL or identifier for display */
115
- actionIcon?: string;
116
- /** If true, this activity cannot be updated or deleted via REST API */
117
- immutable?: boolean;
118
- }
119
- /**
120
- * Configuration for subscribing to activities.
121
- * Behavior is determined by the props passed:
122
- * - No config → org-wide
123
- * - documentIds → specific documents
124
- * - currentDocumentOnly → current document only
125
- */
126
- export interface ActivitySubscribeConfig {
127
- /** Subscribe to activities for a specific organization (defaults to current org) */
128
- organizationId?: string;
129
- /** Subscribe to activities for specific document IDs */
130
- documentIds?: string[];
131
- /** Subscribe to activities for the current document only (auto-switches on setDocument) */
132
- currentDocumentOnly?: boolean;
133
- /** Only fetch activities from the last N days (default: 30) */
134
- maxDays?: number;
135
- /** Allowlist: only include activities with these feature types */
136
- featureTypes?: ActivityFeatureType[];
137
- /** Disallowlist: exclude activities with these feature types (ignored if featureTypes is set) */
138
- excludeFeatureTypes?: ActivityFeatureType[];
139
- /** Allowlist: only include activities with these action types */
140
- actionTypes?: string[];
141
- /** Disallowlist: exclude activities with these action types (ignored if actionTypes is set) */
142
- excludeActionTypes?: string[];
143
- /** Allowlist: only include activities by these user IDs */
144
- userIds?: string[];
145
- /** Disallowlist: exclude activities by these user IDs (ignored if userIds is set) */
146
- excludeUserIds?: string[];
147
- }
148
- /**
149
- * Represents an active activity subscription.
150
- * Returned by `activityService.subscribe()`.
151
- */
152
- export interface ActivitySubscription {
153
- /** Observable stream of activities for this subscription's scope. null = not yet loaded. */
154
- getActivities$(): Observable<ActivityRecord[] | null>;
155
- /** Unsubscribe and clean up this subscription */
156
- unsubscribe(): void;
157
- }
158
- /**
159
- * Data required to create an activity.
160
- * Used for all activity types: comment, reaction, recorder, custom, etc.
161
- */
162
- export interface CreateActivityData<TEntity = unknown, TTarget = unknown> {
163
- featureType: ActivityFeatureType;
164
- actionType: string;
165
- eventType?: string;
166
- targetEntityId: string;
167
- targetSubEntityId?: string | null;
168
- changes?: ActivityChanges;
169
- entityData?: TEntity;
170
- entityTargetData?: TTarget;
171
- /** Icon URL or identifier — typically used for custom activities */
172
- actionIcon?: string;
173
- /** Display message template — only for custom activities */
174
- displayMessageTemplate?: string;
175
- /** Template variable values — only for custom activities */
176
- displayMessageTemplateData?: Record<string, unknown>;
177
- }
@@ -1,58 +0,0 @@
1
- import { ResolverActions } from "../../utils/enums";
2
- import { AttachmentDataProvider } from "./attachment-resolver.data.model";
3
- import { BaseMetadata } from "./base-metadata.data.model";
4
- import { RecorderAnnotation } from "./recorder-annotation.data.model";
5
- import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
6
- import { Attachment } from "./attachment.model";
7
- import { Transcription } from "./transcription.data.model";
8
- import { User } from "./user.data.model";
9
- export interface RecorderAnnotationDataProvider {
10
- get?: (request: GetRecorderResolverRequest) => Promise<ResolverResponse<Record<string, PartialRecorderAnnotation>>>;
11
- save?: (request: SaveRecorderResolverRequest) => Promise<ResolverResponse<SaveRecorderResolverData | undefined>>;
12
- delete?: (request: DeleteRecorderResolverRequest) => Promise<ResolverResponse<undefined>>;
13
- config?: ResolverConfig;
14
- uploadChunks?: boolean;
15
- storage?: AttachmentDataProvider;
16
- }
17
- export interface GetRecorderResolverRequest {
18
- organizationId: string;
19
- recorderAnnotationIds?: string[];
20
- documentIds?: string[];
21
- }
22
- export interface SaveRecorderResolverRequest {
23
- recorderAnnotation: Record<string, PartialRecorderAnnotation>;
24
- event?: ResolverActions;
25
- metadata?: BaseMetadata;
26
- }
27
- export interface SaveRecorderResolverData {
28
- transcription?: Transcription;
29
- attachment?: Attachment | null;
30
- attachments?: Attachment[];
31
- }
32
- export interface DeleteRecorderResolverRequest {
33
- recorderAnnotationId: string;
34
- metadata?: BaseMetadata;
35
- event?: ResolverActions;
36
- }
37
- export interface PartialRecorderAnnotation {
38
- annotationId: string;
39
- metadata?: BaseMetadata;
40
- from?: User;
41
- transcription?: Transcription;
42
- attachment?: Attachment | null;
43
- attachments?: Attachment[];
44
- chunkUrls?: Record<number, string>;
45
- recordingEditVersions?: Record<number, PartialRecorderAnnotationEditVersion>;
46
- [key: string]: any;
47
- }
48
- export interface PartialRecorderAnnotationEditVersion {
49
- from?: User;
50
- attachment?: Attachment | null;
51
- attachments?: Attachment[];
52
- transcription?: Transcription;
53
- }
54
- export interface PartialRecorderAnnotationResult {
55
- strippedData: Record<string, PartialRecorderAnnotation> | null;
56
- originalData: RecorderAnnotation | null;
57
- eventType?: ResolverActions;
58
- }
@@ -1,33 +0,0 @@
1
- // @ts-nocheck
2
- import { Observable } from "rxjs";
3
- import { ActivityRecord, ActivitySubscribeConfig, CreateActivityData } from "../data/activity.data.model";
4
-
5
- export declare class ActivityElement {
6
-
7
- /**
8
- * Subscribe to activities with optional filtering configuration.
9
- * Returns an Observable that, when unsubscribed, automatically cleans up the internal subscription.
10
- * @param config Optional configuration to filter activities by scope, feature types, action types, etc.
11
- * @returns Observable<ActivityRecord[] | null>
12
- */
13
- getAllActivities: (config?: ActivitySubscribeConfig) => Observable<ActivityRecord[] | null>;
14
-
15
- /**
16
- * Create a new activity record.
17
- * @param data The activity data including feature type, action type, target entity, etc.
18
- * @returns Promise<void>
19
- */
20
- createActivity: (data: CreateActivityData) => Promise<void>;
21
-
22
- constructor();
23
-
24
- /**
25
- * Subscribe to activities with optional filtering configuration.
26
- */
27
- private _getAllActivities;
28
-
29
- /**
30
- * Create a new activity record.
31
- */
32
- private _createActivity;
33
- }