@veltdev/types-dev 4.3.0-beta.18 → 4.3.0-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.
@@ -1,4 +1,3 @@
1
- import { RecorderFileFormat } from "../../utils/enums";
2
1
  export declare class Attachment {
3
2
  /**
4
3
  * Unique identifier for the comment pin annotation.
@@ -21,7 +20,7 @@ export declare class Attachment {
21
20
  /**
22
21
  * File type
23
22
  */
24
- type?: RecorderFileFormat;
23
+ type?: string;
25
24
  /**
26
25
  * Download url of a file
27
26
  */
@@ -180,7 +180,4 @@ export interface FetchCommentAnnotationsRequest {
180
180
  locationId?: string;
181
181
  documentIds?: string[];
182
182
  folderId?: string;
183
- resolvedBy?: string;
184
- userIds?: string[];
185
- mentionedUserIds?: string[];
186
183
  }
@@ -132,7 +132,7 @@ export interface GetCommentAnnotationsResponse {
132
132
  data: Record<string, CommentAnnotation[]> | null;
133
133
  }
134
134
  export interface FetchCommentAnnotationsResponse extends GetCommentAnnotationsResponse {
135
- nextPageToken?: string;
135
+ nextPageToken: string;
136
136
  }
137
137
  export interface GetCommentAnnotationsCountResponse {
138
138
  data: Record<string, CommentAnnotationsCount> | null;
@@ -3,24 +3,24 @@ import { BaseMetadata } from "./base-metadata.data.model";
3
3
  import { CommentAnnotation } from "./comment-annotation.data.model";
4
4
  import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
5
5
  export interface CommentAnnotationDataProvider {
6
- get: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
7
- save: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
8
- delete: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
6
+ get: (request: GetCommentRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
7
+ save: (request: SaveCommentRequest) => Promise<ResolverResponse<undefined>>;
8
+ delete: (request: DeleteCommentRequest) => Promise<ResolverResponse<undefined>>;
9
9
  config?: ResolverConfig;
10
10
  }
11
- export interface GetCommentResolverRequest {
11
+ export interface GetCommentRequest {
12
12
  organizationId: string;
13
13
  commentAnnotationIds?: string[];
14
14
  documentIds?: string[];
15
15
  folderId?: string;
16
16
  allDocuments?: boolean;
17
17
  }
18
- export interface DeleteCommentResolverRequest {
18
+ export interface DeleteCommentRequest {
19
19
  commentAnnotationId: string;
20
20
  metadata?: BaseMetadata;
21
21
  event?: ResolverActions;
22
22
  }
23
- export interface SaveCommentResolverRequest {
23
+ export interface SaveCommentRequest {
24
24
  commentAnnotation: {
25
25
  [key: string]: PartialCommentAnnotation;
26
26
  };
@@ -11,8 +11,6 @@ declare class FilterTypeConfig {
11
11
  export declare class CommentSidebarFilterConfig {
12
12
  location?: FilterTypeConfig;
13
13
  people?: FilterTypeConfig;
14
- assigned?: FilterTypeConfig;
15
- tagged?: FilterTypeConfig;
16
14
  priority?: FilterTypeConfig;
17
15
  status?: FilterTypeConfig;
18
16
  category?: FilterTypeConfig;
@@ -1,15 +1,5 @@
1
1
  import { CoreEventTypes } from "../../utils/enums";
2
2
  import { VeltButtonClickEvent } from "./button.data.model";
3
- import { User } from "./user.data.model";
4
3
  export type CoreEventTypesMap = {
5
4
  [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
6
- [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
7
- [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
8
- [CoreEventTypes.ERROR]: ErrorEvent;
9
- };
10
- export type UserUpdateEvent = User | null;
11
- export type DocumentInitEvent = boolean | undefined;
12
- export type ErrorEvent = {
13
- code: string;
14
- message?: string;
15
5
  };
@@ -1,4 +1,3 @@
1
- import { HuddleType } from "../../utils/enums";
2
1
  import { User } from "./user.data.model";
3
2
  export declare class Attendee extends User {
4
3
  state?: {
@@ -13,7 +12,7 @@ export declare class Attendee extends User {
13
12
  screenSharing?: boolean;
14
13
  };
15
14
  streamMetadata?: any;
16
- initialHuddleType?: HuddleType;
15
+ initialHuddleType?: 'audio' | 'video' | 'presentation';
17
16
  huddleOnCursorMode?: boolean;
18
17
  }
19
18
  export declare class Message {
@@ -1,4 +1,3 @@
1
- import { SingleEditorState, SingleEditorStatus } from "../../utils/enums";
2
1
  import { User } from "./user.data.model";
3
2
  export declare class LiveStateData {
4
3
  /**
@@ -25,7 +24,7 @@ export declare class SingleEditorLiveStateData {
25
24
  requestEditorAccess?: {
26
25
  user: User;
27
26
  requestedAt: any;
28
- status: SingleEditorStatus;
27
+ status: 'pending' | 'accepted' | 'rejected' | 'cancelled';
29
28
  editorAccessTimeout: number;
30
29
  tabId?: string | null;
31
30
  } | null;
@@ -57,7 +56,7 @@ export declare class EditorAccessTimer {
57
56
  /**
58
57
  * The time when the editor access was requested.
59
58
  */
60
- state: SingleEditorState;
59
+ state: 'idle' | 'inProgress' | 'completed';
61
60
  /**
62
61
  * Duration left for the editor access timer to be completed.
63
62
  */
@@ -1,4 +1,4 @@
1
- import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
1
+ import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, TagStatus, UserActionTypes } from "../../utils/enums";
2
2
  import { DocumentMetadata } from "./document-metadata.model";
3
3
  import { DocumentUser } from "./document-user.data.model";
4
4
  import { Location } from "./location.model";
@@ -19,7 +19,7 @@ export declare class NotificationRawData {
19
19
  /**
20
20
  * Source of a notification
21
21
  */
22
- notificationSource?: NotificationSource;
22
+ notificationSource?: 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
23
23
  /**
24
24
  * Type of notification like 'Added', 'Updated' etc.
25
25
  */
@@ -1,4 +1,3 @@
1
- import { User } from "./user.data.model";
2
1
  export declare class OrganizationUserGroup {
3
2
  metadata: {
4
3
  groupId: string;
@@ -9,8 +8,3 @@ export declare class OrganizationUserGroup {
9
8
  [userIdHash: string]: boolean;
10
9
  };
11
10
  }
12
- export declare class UserGroup {
13
- groupId: string;
14
- groupName: string;
15
- users?: User[];
16
- }
@@ -3,24 +3,24 @@ import { ReactionAnnotation } from "./reaction-annotation.data.model";
3
3
  import { ResolverResponse, ResolverConfig } from "./resolver.data.model";
4
4
  import { ResolverActions } from "../../utils/enums";
5
5
  export interface ReactionAnnotationDataProvider {
6
- get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
7
- save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
8
- delete: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
6
+ get: (request: GetReactionRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
7
+ save: (request: SaveReactionRequest) => Promise<ResolverResponse<undefined>>;
8
+ delete: (request: DeleteReactionRequest) => Promise<ResolverResponse<undefined>>;
9
9
  config?: ResolverConfig;
10
10
  }
11
- export interface GetReactionResolverRequest {
11
+ export interface GetReactionRequest {
12
12
  organizationId: string;
13
13
  reactionAnnotationIds?: string[];
14
14
  documentIds?: string[];
15
15
  folderId?: string;
16
16
  allDocuments?: boolean;
17
17
  }
18
- export interface DeleteReactionResolverRequest {
18
+ export interface DeleteReactionRequest {
19
19
  reactionAnnotationId: string;
20
20
  metadata?: BaseMetadata;
21
21
  event?: ResolverActions;
22
22
  }
23
- export interface SaveReactionResolverRequest {
23
+ export interface SaveReactionRequest {
24
24
  reactionAnnotation: {
25
25
  [key: string]: PartialReactionAnnotation;
26
26
  };
@@ -1,4 +1,3 @@
1
- import { RecorderFileFormat, RecorderLayoutMode, RecorderType } from "../../utils/enums";
2
1
  import { Attachment } from "./attachment.model";
3
2
  import { BaseMetadata } from "./base-metadata.data.model";
4
3
  import { CursorPosition } from "./cursor-position.data.model";
@@ -93,8 +92,8 @@ export declare class RecorderAnnotation {
93
92
  */
94
93
  location?: Location | null;
95
94
  type?: string;
96
- recordingType: RecorderType;
97
- mode: RecorderLayoutMode;
95
+ recordingType: string;
96
+ mode: 'floating' | 'thread';
98
97
  approved?: boolean;
99
98
  /**
100
99
  * Attachment object of recorded media
@@ -143,6 +142,10 @@ export declare class RecorderAnnotation {
143
142
  recordingEditVersions?: {
144
143
  [key: number]: RecorderAnnotationEditVersion;
145
144
  };
145
+ /**
146
+ * Folder ID where chunks are stored in storage
147
+ */
148
+ recordingFolderId?: string;
146
149
  /**
147
150
  * URLs for individual uploaded chunks
148
151
  */
@@ -193,12 +196,10 @@ declare class RecorderDataAsset {
193
196
  * The format/extension of the file
194
197
  * @example 'mp3', 'mp4', 'webm'
195
198
  */
196
- fileFormat?: RecorderFileFormat;
199
+ fileFormat?: 'mp3' | 'mp4' | 'webm' | string;
197
200
  thumbnailUrl?: string;
198
201
  }
199
202
  export declare class RecorderData {
200
- recorderId: string;
201
- metadata?: RecorderMetadata;
202
203
  assets: RecorderDataAsset[];
203
204
  transcription: RecorderDataTranscription;
204
205
  }
@@ -208,6 +209,4 @@ export interface RecorderRequestQuery {
208
209
  export interface GetRecordingDataResponse {
209
210
  data: Record<string, RecorderData> | null;
210
211
  }
211
- export interface GetRecordingsResponse extends RecorderData {
212
- }
213
212
  export {};
@@ -1,13 +1,8 @@
1
- import { RecorderData } from "../../models/data/recorder-annotation.data.model";
2
1
  import { RecorderEventTypes } from "../../utils/enums";
3
- export interface TranscriptionDoneEvent extends RecorderData {
4
- }
5
- export interface RecordingDoneEvent extends RecorderData {
6
- }
7
- export interface RecordingDeleteEvent extends RecorderData {
2
+ import { RecorderData } from "./recorder-annotation.data.model";
3
+ export interface TranscriptionDoneEvent {
4
+ data: Record<string, RecorderData> | null;
8
5
  }
9
6
  export type RecorderEventTypesMap = {
10
7
  [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
11
- [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;
12
- [RecorderEventTypes.DELETE_RECORDING]: RecordingDeleteEvent;
13
8
  };
@@ -1,5 +1,4 @@
1
1
  import { Observable } from "rxjs";
2
- import { RecorderType } from "../../utils/enums";
3
2
  export declare class RecorderConfig {
4
3
  type: {
5
4
  audio?: boolean;
@@ -27,7 +26,7 @@ export declare class RecorderInitData {
27
26
  /**
28
27
  * Type of media recorder, possible values are 'audio', 'video' and 'screen'
29
28
  */
30
- type: RecorderType;
29
+ type: 'audio' | 'video' | 'screen';
31
30
  /**
32
31
  * Observable of recorded raw data.
33
32
  */
@@ -45,7 +44,7 @@ export declare class RecordedRawData {
45
44
  /**
46
45
  * Type of recorded data, possible values are 'audio' and 'video'
47
46
  */
48
- type: RecorderType;
47
+ type: 'audio' | 'video' | 'screen';
49
48
  /**
50
49
  * Base64 encoded string of thumbnail image of one frame of recorded video
51
50
  */
@@ -63,6 +62,10 @@ export declare class RecordedRawData {
63
62
  chunkUrls?: {
64
63
  [key: number]: string;
65
64
  };
65
+ /**
66
+ * Folder ID where chunks are stored in storage
67
+ */
68
+ recordingFolderId?: string;
66
69
  }
67
70
  export declare class RecordedData {
68
71
  /**
@@ -85,6 +88,10 @@ export declare class RecordedData {
85
88
  * URL of the hosted website to open video in new tab
86
89
  */
87
90
  videoPlayerUrl?: string;
91
+ /**
92
+ * Folder ID where chunks are stored in storage
93
+ */
94
+ recordingFolderId?: string;
88
95
  /**
89
96
  * URLs for individual uploaded chunks
90
97
  */
@@ -1,9 +1,7 @@
1
1
  // @ts-nocheck
2
2
  import { Observable } from "rxjs";
3
- import { ContactListScopeForOrganizationUsers } from "../../utils/enums";
4
- import { GetContactListResponse } from "../data/contact-utils.data.model";
5
3
  import { SelectedUserContact } from "../data/user-contact.data.model";
6
-
4
+ import { ContactListScopeForOrganizationUsers } from "../../utils/enums";
7
5
  export declare class ContactElement {
8
6
  /**
9
7
  * Get if user is part of global contact or not.
@@ -47,11 +45,6 @@ export declare class ContactElement {
47
45
  * @param config {merge: boolean}
48
46
  */
49
47
  public updateContactList: (userContacts: UserContact[], config?: { merge: boolean }) => void;
50
-
51
- /**
52
- * Get contact list.
53
- */
54
- public getContactList: () => Observable<GetContactListResponse | null>;
55
48
  constructor();
56
49
  /**
57
50
  * Get if user is part of global contact or not.
@@ -95,9 +88,4 @@ export declare class ContactElement {
95
88
  * @param config {merge: boolean}
96
89
  */
97
90
  private _updateContactList;
98
-
99
- /**
100
- * Get contact list.
101
- */
102
- private _getContactList;
103
91
  }
@@ -1,17 +1,13 @@
1
1
  // @ts-nocheck
2
2
  import { Observable } from "rxjs";
3
- import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse, GetRecordingsResponse } from "../data/recorder-annotation.data.model";
3
+ import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse } from "../data/recorder-annotation.data.model";
4
4
  import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
5
- import { RecordedData } from "../data/recorder.model";
6
5
 
7
6
  export declare class RecorderElement {
8
7
 
9
8
  initRecording: (type: string, panelId?: string) => any;
10
9
 
11
- /**
12
- * @deprecated Use on('recordingDone') method instead
13
- */
14
- onRecordedData: () => Observable<RecordedData | null>;
10
+ onRecordedData: () => Observable<any>;
15
11
 
16
12
  /**
17
13
  * To enable recording countdown
@@ -59,18 +55,10 @@ export declare class RecorderElement {
59
55
  */
60
56
  disableVideoEditor: () => void;
61
57
 
62
- /**
63
- * To get recordings
64
- */
65
- getRecordings: (query?: RecorderRequestQuery) => Observable<GetRecordingsResponse>;
66
-
67
58
  constructor();
68
59
 
69
60
  private _initRecording;
70
61
 
71
- /**
72
- * @deprecated Use on('recordingDone') method instead
73
- */
74
62
  private _onRecordedData;
75
63
 
76
64
  /**
@@ -118,9 +106,4 @@ export declare class RecorderElement {
118
106
  * To disable video editor
119
107
  */
120
108
  private _disableVideoEditor;
121
-
122
- /**
123
- * To get recordings
124
- */
125
- private _getRecordings;
126
109
  }
@@ -55,14 +55,9 @@ export declare const CommentEventTypes: {
55
55
  };
56
56
  export declare const RecorderEventTypes: {
57
57
  readonly TRANSCRIPTION_DONE: "transcriptionDone";
58
- readonly RECORDING_DONE: "recordingDone";
59
- readonly DELETE_RECORDING: "deleteRecording";
60
58
  };
61
59
  export declare const CoreEventTypes: {
62
60
  readonly VELT_BUTTON_CLICK: "veltButtonClick";
63
- readonly USER_UPDATE: "userUpdate";
64
- readonly DOCUMENT_INIT: "documentInit";
65
- readonly ERROR: "error";
66
61
  };
67
62
  export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
68
63
  export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
@@ -179,44 +174,5 @@ export declare enum ContactListScopeForOrganizationUsers {
179
174
  ALL = "all",
180
175
  ORGANIZATION = "organization",
181
176
  ORGANIZATION_USER_GROUP = "organizationUserGroup",
182
- DOCUMENT = "document",
183
- FOLDER = "folder"
184
- }
185
- export type RecorderMode = 'audio' | 'video' | 'screen' | 'all' | string;
186
- export type RecorderType = 'audio' | 'video' | 'screen';
187
- export type RecorderFileFormat = 'mp3' | 'mp4' | 'webm';
188
- export type RecorderLayoutMode = 'floating' | 'thread';
189
- export type SupportedMimeType = 'audio' | 'video';
190
- export type FirebaseRegion = 'usCentral1' | 'asiaSouthEast1' | 'europeWest1';
191
- export type VideoEventType = 'play' | 'pause' | 'ratechange' | 'seeked' | 'timeupdate' | 'volumechange';
192
- export type RewriterType = 'copywriter' | 'generic';
193
- export type RecorderStatusType = 'started' | 'paused' | 'resumed' | 'stopped' | 'error' | null;
194
- export type HuddleType = 'audio' | 'video' | 'presentation';
195
- export type NotificationTabId = 'for-you' | 'all' | 'document' | 'people';
196
- export type NotificationTabType = 'forYou' | 'all' | 'documents' | 'people';
197
- export type NotificationSource = 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
198
- export type SingleEditorStatus = 'pending' | 'accepted' | 'rejected' | 'cancelled';
199
- export type SingleEditorState = 'idle' | 'inProgress' | 'completed';
200
- export type AudioWaveformVariant = 'expanded' | 'minified' | 'player' | 'preview' | 'preview-mini' | 'editor';
201
- export type ActionButtonType = 'button' | 'button-toggle' | 'multi-select' | 'single-select';
202
- export type DropdownPosition = 'left' | 'right' | 'center';
203
- export type DevicePermissionType = 'audio' | 'video';
204
- export type TranscriptionMode = 'floating' | 'embed' | 'summaryMode';
205
- export type ComposerPosition = 'top' | 'bottom';
206
- export type SortBy = 'lastUpdated' | 'createdAt';
207
- export type SortOrder = 'asc' | 'desc';
208
- export type MinimapPosition = 'left' | 'right';
209
- export type FilterOptionLayout = 'dropdown' | 'checkbox';
210
- export type FilterPanelPosition = 'menu' | 'bottomSheet';
211
- export type OverlayOriginY = 'top' | 'center' | 'bottom';
212
- export type OverlayOriginX = 'start' | 'center' | 'end';
213
- export type SubtitlesMode = 'floating' | 'embed';
214
- export type RecorderVariant = 'default' | 'embed';
215
- export type ReactionPinType = 'timeline' | 'comment';
216
- export type SidebarPosition = 'left' | 'right';
217
- export type SidebarSortingCriteria = 'date' | 'unread' | null;
218
- export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved';
219
- export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'pages' | 'statuses' | 'priorities' | 'categories' | 'versions';
220
- export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
221
- export type NotificationPanelMode = 'popover' | 'sidebar';
222
- export type SidebarActionButtonType = 'default' | 'toggle';
177
+ DOCUMENT = "document"
178
+ }
package/models.d.ts CHANGED
@@ -9,9 +9,7 @@ export * from './app/models/data/comment-annotation.data.model';
9
9
  export * from './app/models/data/comment-events.data.model';
10
10
  export * from './app/models/data/comment.data.model';
11
11
  export * from './app/models/data/comment-actions.data.model';
12
- export * from './app/models/data/comment-resolver.data.model';
13
12
  export * from './app/models/data/comment-utils.data.model';
14
- export * from './app/models/data/contact-utils.data.model';
15
13
  export * from './app/models/data/config.data.model';
16
14
  export * from './app/models/data/core-events.data.model';
17
15
  export * from './app/models/data/cursor-position.data.model';
@@ -63,7 +61,6 @@ export * from './app/models/data/comment-sidebar-config.model';
63
61
  export * from './app/models/data/views.data.model';
64
62
  export * from './app/models/data/autocomplete.data.model';
65
63
  export * from './app/models/data/reaction-annotation.data.model';
66
- export * from './app/models/data/reaction-resolver.data.model';
67
64
  export * from './app/models/data/reaction.data.model';
68
65
  export * from './app/models/data/organization-groups.data.model';
69
66
  export * from './app/models/data/organization-metadata.model';
@@ -71,4 +68,3 @@ export * from './app/models/data/user-organization.data.model';
71
68
  export * from './app/models/data/event-metadata.data.model';
72
69
  export * from './app/models/data/user-resolver.data.model';
73
70
  export * from './app/models/data/provider.data.model';
74
- export * from './app/models/data/resolver.data.model';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/types-dev",
3
- "version": "4.3.0-beta.18",
3
+ "version": "4.3.0-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": [
@@ -1,9 +0,0 @@
1
- import { UserGroup } from "./organization-groups.data.model";
2
- import { User } from "./user.data.model";
3
- export interface GetContactListResponse {
4
- organizationUsers?: User[];
5
- folderUsers?: User[];
6
- documentUsers?: User[];
7
- userGroups?: UserGroup[];
8
- updatedContactList?: User[];
9
- }