@veltdev/sdk-staging 5.0.2-beta.19 → 5.0.2-beta.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.
@@ -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
  */
@@ -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
  }
@@ -141,8 +141,6 @@ export interface AddCommentRequest {
141
141
  assignedTo?: User;
142
142
  assigned?: boolean;
143
143
  options?: RequestOptions;
144
- /** Optional visibility configuration for the comment */
145
- visibility?: CommentVisibilityConfig;
146
144
  }
147
145
  export interface UpdateCommentRequest {
148
146
  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;
@@ -186,11 +183,6 @@ export interface CommentSavedEvent {
186
183
  commentAnnotation: CommentAnnotation;
187
184
  metadata: VeltEventMetadata;
188
185
  }
189
- export interface CommentSaveTriggeredEvent {
190
- annotationId: string;
191
- commentAnnotation: CommentAnnotation;
192
- metadata: VeltEventMetadata;
193
- }
194
186
  export interface UpdateCommentEvent {
195
187
  annotationId: string;
196
188
  commentAnnotation: CommentAnnotation;
@@ -317,23 +309,18 @@ export interface CommentToolClickEvent {
317
309
  targetElementId?: string | null;
318
310
  metadata?: VeltEventMetadata;
319
311
  }
320
- export interface CommentToolClickedEvent extends CommentToolClickEvent {
321
- }
322
312
  export interface SidebarButtonClickEvent {
323
313
  metadata?: VeltEventMetadata;
324
314
  }
325
- export interface SidebarButtonClickedEvent extends SidebarButtonClickEvent {
326
- }
327
315
  export interface AttachmentDownloadClickedEvent {
328
316
  annotationId: string;
329
317
  commentAnnotation: CommentAnnotation;
330
318
  attachment: Attachment;
331
319
  metadata?: VeltEventMetadata;
332
320
  }
333
- export interface VisibilityOptionClickedEvent {
321
+ export interface LocationClickedEvent {
334
322
  annotationId: string;
335
323
  commentAnnotation: CommentAnnotation;
336
- visibility: CommentVisibilityOptionType;
337
- users?: any[];
324
+ location: 'public' | 'private';
338
325
  metadata?: VeltEventMetadata;
339
326
  }
@@ -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
  }
@@ -23,8 +23,7 @@ export declare enum UserResolverSource {
23
23
  SET_SINGLE_EDITOR_MODE_LIVE_STATE_DATA_FOR_DIFFERENT_USER_PRESENT_ON_TAB = "setSingleEditorModeLiveStateDataForDifferentUserPresentOnTab",
24
24
  RESOLVE_AND_MERGE_SINGLE_EDITOR_LIVE_STATE_DATA_WITH_USER = "resolveAndMergeSingleEditorLiveStateDataWithUser",
25
25
  GET_SINGLE_EDITOR_MODE_DATA = "getSingleEditorModeData",
26
- RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages",
27
- RESOLVE_USER_IDS_BY_EMAIL = "resolveUserIdsByEmail"
26
+ RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages"
28
27
  }
29
28
  export declare enum UserResolverModuleName {
30
29
  IDENTIFY = "identify/authProvider",
@@ -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,11 +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 { AnonymousUserDataProvider, UserDataProvider } from "./user-resolver.data.model";
4
+ import { UserDataProvider } from "./user-resolver.data.model";
5
5
  export interface VeltDataProvider {
6
6
  comment?: CommentAnnotationDataProvider;
7
7
  user?: UserDataProvider;
8
8
  reaction?: ReactionAnnotationDataProvider;
9
9
  attachment?: AttachmentDataProvider;
10
- anonymousUser?: AnonymousUserDataProvider;
11
10
  }
@@ -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
  */
@@ -1625,16 +1615,6 @@ export declare class CommentElement {
1625
1615
  */
1626
1616
  private _disableStatus;
1627
1617
 
1628
- /**
1629
- * To enable visibility options on comments
1630
- */
1631
- private _enableVisibilityOptions;
1632
-
1633
- /**
1634
- * To disable visibility options on comments
1635
- */
1636
- private _disableVisibilityOptions;
1637
-
1638
1618
  /**
1639
1619
  * To enable feature to show resolve button
1640
1620
  */
@@ -95,11 +95,6 @@ export declare class CrdtElement {
95
95
  * @param time debounce time in milliseconds
96
96
  */
97
97
  setWebhookDebounceTime: (time: number) => void;
98
- /**
99
- * To set activity debounce time for batching CRDT edits (Default value is 10 minutes)
100
- * @param time debounce time in milliseconds (minimum: 10 seconds)
101
- */
102
- setActivityDebounceTime: (time: number) => void;
103
98
 
104
99
  /**
105
100
  * Subscribe to crdt actions
@@ -209,12 +204,6 @@ export declare class CrdtElement {
209
204
  */
210
205
  private _setWebhookDebounceTime;
211
206
 
212
- /**
213
- * Set activity debounce time for batching CRDT edits
214
- * @param time debounce time in milliseconds (minimum: 10 seconds)
215
- */
216
- private _setActivityDebounceTime;
217
-
218
207
  /**
219
208
  * Subscribe to crdt actions
220
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;
@@ -60,13 +60,10 @@ export declare const CommentEventTypes: {
60
60
  readonly COMMENT_PIN_CLICKED: "commentPinClicked";
61
61
  readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
62
62
  readonly COMMENT_TOOL_CLICK: "commentToolClick";
63
- readonly COMMENT_TOOL_CLICKED: "commentToolClicked";
64
63
  readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
65
- readonly SIDEBAR_BUTTON_CLICKED: "sidebarButtonClicked";
66
64
  readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
67
65
  readonly COMMENT_SAVED: "commentSaved";
68
- readonly COMMENT_SAVE_TRIGGERED: "commentSaveTriggered";
69
- readonly VISIBILITY_OPTION_CLICKED: "visibilityOptionClicked";
66
+ readonly LOCATION_CLICKED: "locationClicked";
70
67
  };
71
68
  export declare const RecorderEventTypes: {
72
69
  readonly TRANSCRIPTION_DONE: "transcriptionDone";
@@ -172,8 +169,7 @@ export declare enum Features {
172
169
  REWRITER = "rewriter",
173
170
  LIVE_SELECTION = "liveSelection",
174
171
  NOTIFICATION = "notification",
175
- REACTION = "reaction",
176
- ACTIVITY = "activity"
172
+ REACTION = "reaction"
177
173
  }
178
174
  export declare enum AnalyticsFeatures {
179
175
  AREA = "area",
@@ -195,7 +191,7 @@ export declare enum AnalyticsFeatures {
195
191
  INLINE_COMMENT = "inlineComment",
196
192
  COMMENT_SIDEBAR = "commentSidebar"
197
193
  }
198
- export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread' | 'activity';
194
+ export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
199
195
  export type AssignToType = 'dropdown' | 'checkbox';
200
196
  export declare enum DeviceType {
201
197
  DESKTOP = "Desktop",
@@ -314,13 +310,3 @@ export type NotificationSettingsItemType = 'ALL' | 'MINE' | 'NONE' | string;
314
310
  * Type for notification settings layout
315
311
  */
316
312
  export type NotificationSettingsLayout = 'accordion' | 'dropdown';
317
- /**
318
- * Enum for comment visibility options in the visibility banner dropdown
319
- */
320
- export declare enum CommentVisibilityOption {
321
- RESTRICTED_SELF = "restrictedSelf",
322
- RESTRICTED_SELECTED_PEOPLE = "restrictedSelectedPeople",
323
- ORGANIZATION_PRIVATE = "organizationPrivate",
324
- PUBLIC = "public"
325
- }
326
- 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';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk-staging",
3
- "version": "5.0.2-beta.19",
3
+ "version": "5.0.2-beta.2",
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": [