@veltdev/types 4.7.2 → 4.7.4

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 (75) hide show
  1. package/app/models/data/anchor-record.data.model.d.ts +109 -0
  2. package/app/models/data/area-annotation.data.model.d.ts +7 -1
  3. package/app/models/data/arrow-annotation.data.model.d.ts +51 -0
  4. package/app/models/data/attachment-resolver.data.model.d.ts +52 -0
  5. package/app/models/data/attachment.model.d.ts +21 -1
  6. package/app/models/data/autocomplete.data.model.d.ts +51 -0
  7. package/app/models/data/base-metadata.data.model.d.ts +9 -0
  8. package/app/models/data/button.data.model.d.ts +37 -0
  9. package/app/models/data/comment-actions.data.model.d.ts +199 -0
  10. package/app/models/data/comment-annotation.data.model.d.ts +80 -4
  11. package/app/models/data/comment-events.data.model.d.ts +279 -0
  12. package/app/models/data/comment-resolver.data.model.d.ts +72 -0
  13. package/app/models/data/comment-sidebar-config.model.d.ts +95 -0
  14. package/app/models/data/comment-utils.data.model.d.ts +16 -0
  15. package/app/models/data/comment.data.model.d.ts +26 -1
  16. package/app/models/data/config.data.model.d.ts +23 -0
  17. package/app/models/data/contact-utils.data.model.d.ts +9 -0
  18. package/app/models/data/core-events.data.model.d.ts +180 -0
  19. package/app/models/data/crdt-events.data.model.d.ts +25 -0
  20. package/app/models/data/crdt.data.model.d.ts +60 -0
  21. package/app/models/data/cursor-position.data.model.d.ts +15 -0
  22. package/app/models/data/cursor-user.data.model.d.ts +5 -0
  23. package/app/models/data/custom-chip-dropdown.data.model.d.ts +10 -0
  24. package/app/models/data/custom-css.data.model.d.ts +10 -0
  25. package/app/models/data/custom-filter.data.model.d.ts +8 -0
  26. package/app/models/data/customer-metadata.data.model.d.ts +15 -0
  27. package/app/models/data/document-events.data.model.d.ts +8 -0
  28. package/app/models/data/document-iam.data.model.d.ts +8 -0
  29. package/app/models/data/document-metadata.model.d.ts +28 -0
  30. package/app/models/data/document-paths.data.model.d.ts +51 -1
  31. package/app/models/data/document.data.model.d.ts +63 -0
  32. package/app/models/data/encryption-provider.data.model.d.ts +12 -0
  33. package/app/models/data/event-metadata.data.model.d.ts +32 -0
  34. package/app/models/data/folder-metadata.model.d.ts +40 -0
  35. package/app/models/data/heartbeat.data.model.d.ts +16 -0
  36. package/app/models/data/huddle.model.d.ts +2 -1
  37. package/app/models/data/live-state-data-map.data.model.d.ts +7 -6
  38. package/app/models/data/live-state-data.data.model.d.ts +37 -2
  39. package/app/models/data/live-state-events.data.model.d.ts +23 -0
  40. package/app/models/data/location-metadata.model.d.ts +14 -0
  41. package/app/models/data/location.model.d.ts +0 -2
  42. package/app/models/data/media-preview-config.data.model.d.ts +3 -0
  43. package/app/models/data/multi-thread.data.model.d.ts +63 -0
  44. package/app/models/data/notification.model.d.ts +129 -3
  45. package/app/models/data/notifications-events.data.model.d.ts +9 -0
  46. package/app/models/data/organization-groups.data.model.d.ts +16 -0
  47. package/app/models/data/organization-metadata.model.d.ts +31 -0
  48. package/app/models/data/page-info.model.d.ts +4 -0
  49. package/app/models/data/presence-actions.data.model.d.ts +5 -0
  50. package/app/models/data/presence-events.data.model.d.ts +16 -0
  51. package/app/models/data/presence-user.data.model.d.ts +7 -0
  52. package/app/models/data/provider.data.model.d.ts +10 -0
  53. package/app/models/data/reaction-annotation.data.model.d.ts +68 -0
  54. package/app/models/data/reaction-resolver.data.model.d.ts +42 -0
  55. package/app/models/data/reaction.data.model.d.ts +18 -0
  56. package/app/models/data/recorder-annotation.data.model.d.ts +101 -9
  57. package/app/models/data/recorder-events.data.model.d.ts +45 -0
  58. package/app/models/data/recorder.model.d.ts +31 -2
  59. package/app/models/data/resolver.data.model.d.ts +36 -0
  60. package/app/models/data/screenshot.data.model.d.ts +10 -0
  61. package/app/models/data/selection.model.d.ts +12 -0
  62. package/app/models/data/sync-video-player.data.model.d.ts +47 -0
  63. package/app/models/data/target-element.data.model.d.ts +5 -0
  64. package/app/models/data/target-text-range.data.model.d.ts +13 -0
  65. package/app/models/data/user-contact.data.model.d.ts +21 -0
  66. package/app/models/data/user-iam.data.model.d.ts +15 -0
  67. package/app/models/data/user-organization.data.model.d.ts +12 -0
  68. package/app/models/data/user-resolver.data.model.d.ts +56 -0
  69. package/app/models/data/user.data.model.d.ts +82 -0
  70. package/app/models/data/views.data.model.d.ts +64 -0
  71. package/app/models/element/comment-element.model.d.ts +42 -2
  72. package/app/utils/constants.d.ts +133 -6
  73. package/app/utils/enums.d.ts +209 -4
  74. package/models.d.ts +36 -0
  75. package/package.json +2 -2
@@ -0,0 +1,180 @@
1
+ import { CoreEventTypes } from "../../utils/enums";
2
+ import { VeltButtonClickEvent } from "./button.data.model";
3
+ import { PermissionSource, User } from "./user.data.model";
4
+ export type CoreEventTypesMap = {
5
+ [CoreEventTypes.PERMISSION_PROVIDER]: PermissionProviderEvent;
6
+ [CoreEventTypes.USER_RESOLVER]: UserResolverEvent;
7
+ [CoreEventTypes.COMMENT_RESOLVER]: CommentResolverEvent;
8
+ [CoreEventTypes.ATTACHMENT_RESOLVER]: AttachmentResolverEvent;
9
+ [CoreEventTypes.REACTION_RESOLVER]: ReactionResolverEvent;
10
+ [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
11
+ [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
12
+ [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
13
+ [CoreEventTypes.ERROR]: ErrorEvent;
14
+ [CoreEventTypes.INIT_UPDATE]: InitUpdateEvent;
15
+ };
16
+ export type UserUpdateEvent = User | null;
17
+ export type DocumentInitEvent = boolean | undefined;
18
+ export declare enum UserResolverSource {
19
+ RESOLVE_USERS = "resolveUsers",
20
+ FORMAT_RESPONSE = "formatResponse",
21
+ MERGE_USER_WITH_PROVIDED_USER_DATA = "mergeUserWithProvidedUserData",
22
+ GET_TEMPORARY_USERS = "getTemporaryUsers",
23
+ SET_SINGLE_EDITOR_MODE_LIVE_STATE_DATA_FOR_DIFFERENT_USER_PRESENT_ON_TAB = "setSingleEditorModeLiveStateDataForDifferentUserPresentOnTab",
24
+ RESOLVE_AND_MERGE_SINGLE_EDITOR_LIVE_STATE_DATA_WITH_USER = "resolveAndMergeSingleEditorLiveStateDataWithUser",
25
+ GET_SINGLE_EDITOR_MODE_DATA = "getSingleEditorModeData",
26
+ RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages"
27
+ }
28
+ export declare enum UserResolverModuleName {
29
+ IDENTIFY = "identify/authProvider",
30
+ GET_TEMPORARY_USERS = "getTemporaryUsers",
31
+ GET_USERS = "getUsers",
32
+ GET_HUDDLE_USERS = "getHuddleUsers",
33
+ GET_SINGLE_EDITOR_USERS = "getSingleEditorUsers"
34
+ }
35
+ export declare enum CommentResolverSource {
36
+ RESOLVE_COMMENT_ANNOTATIONS = "resolveCommentAnnotations",
37
+ SAVE_COMMENT_ANNOTATION = "saveCommentAnnotation",
38
+ DELETE_COMMENT_ANNOTATION = "deleteCommentAnnotation",
39
+ FORMAT_RESPONSE = "formatResponse",
40
+ INIT_DOCUMENTS = "initDocuments",
41
+ SET_DATA = "setData",
42
+ UPDATE_DATA = "updateData",
43
+ DELETE_DATA = "deleteData"
44
+ }
45
+ export declare enum AttachmentResolverSource {
46
+ SAVE_ATTACHMENT = "saveAttachment",
47
+ DELETE_ATTACHMENT = "deleteAttachment",
48
+ UPLOAD_TO_RESOLVER = "uploadToResolver"
49
+ }
50
+ export declare enum ReactionResolverSource {
51
+ RESOLVE_REACTION_ANNOTATIONS = "resolveReactionAnnotations",
52
+ SAVE_REACTION_ANNOTATION = "saveReactionAnnotation",
53
+ DELETE_REACTION_ANNOTATION = "deleteReactionAnnotation",
54
+ FORMAT_RESPONSE = "formatResponse",
55
+ INIT_DOCUMENTS = "initDocuments",
56
+ SET_DATA = "setData",
57
+ UPDATE_DATA = "updateData",
58
+ DELETE_DATA = "deleteData"
59
+ }
60
+ export type BaseResolverEvent<TEventType, TMethodName, TModuleName> = {
61
+ event: TEventType;
62
+ methodName?: TMethodName;
63
+ moduleName?: TModuleName;
64
+ source?: 'internal' | 'external';
65
+ timestamp?: number;
66
+ uniqueId?: string;
67
+ payload?: any;
68
+ };
69
+ export type PermissionProviderEvent = BaseResolverEvent<PermissionProviderEventType, PermissionSource, PermissionProviderModuleName>;
70
+ export declare enum PermissionProviderModuleName {
71
+ }
72
+ export type PermissionProviderEventType = {
73
+ RESOURCE_ACCESS_REQUEST_FORMED: 'resourceAccessRequestFormed';
74
+ RESOURCE_ACCESS_REQUEST_TRIGGERED: 'resourceAccessRequestTriggered';
75
+ RESOURCE_ACCESS_RESULT: 'resourceAccessResult';
76
+ RESOURCE_ACCESS_ERROR: 'resourceAccessError';
77
+ RESOURCE_ACCESS_RESULT_FROM_CACHE: 'resourceAccessResultFromCache';
78
+ REVOKE_ACCESS_ON_DOCUMENT_UNSET_TRIGGERED: 'revokeAccessOnDocumentUnsetTriggered';
79
+ REVOKE_ACCESS_ON_DOCUMENT_UNSET_FORMED: 'revokeAccessOnDocumentUnsetFormed';
80
+ REVOKE_ACCESS_ON_DOCUMENT_UNSET_RESULT: 'revokeAccessOnDocumentUnsetResult';
81
+ REVOKE_ACCESS_ON_USER_LOGOUT_TRIGGERED: 'revokeAccessOnUserLogoutTriggered';
82
+ REVOKE_ACCESS_ON_USER_LOGOUT_FORMED: 'revokeAccessOnUserLogoutFormed';
83
+ REVOKE_ACCESS_ON_USER_LOGOUT_RESULT: 'revokeAccessOnUserLogoutResult';
84
+ REVOKE_ACCESS_ON_DOCUMENT_UNSET_ERROR: 'revokeAccessOnDocumentUnsetError';
85
+ REVOKE_ACCESS_ON_USER_LOGOUT_ERROR: 'revokeAccessOnUserLogoutError';
86
+ };
87
+ export type UserResolverEvent = BaseResolverEvent<UserResolverEventType, UserResolverSource, UserResolverModuleName>;
88
+ export type UserResolverEventType = {
89
+ USER_RESOLUTION_REQUEST_FORMED: 'userResolutionRequestFormed';
90
+ USER_RESOLUTION_REQUEST_TRIGGERED: 'userResolutionRequestTriggered';
91
+ USER_RESOLUTION_RESULT: 'userResolutionResult';
92
+ USER_RESOLUTION_ERROR: 'userResolutionError';
93
+ USER_RESOLUTION_RESULT_FROM_CACHE: 'userResolutionResultFromCache';
94
+ };
95
+ export type CommentResolverEvent = BaseResolverEvent<CommentResolverEventType, CommentResolverSource, CommentResolverModuleName>;
96
+ export declare enum CommentResolverModuleName {
97
+ SET_DOCUMENTS = "setDocuments",
98
+ GET_COMMENT_ANNOTATIONS = "getCommentAnnotations",
99
+ GET_NOTIFICATIONS = "getNotifications"
100
+ }
101
+ export type CommentResolverEventType = {
102
+ COMMENT_RESOLUTION_REQUEST_FORMED: 'commentResolutionRequestFormed';
103
+ COMMENT_RESOLUTION_REQUEST_TRIGGERED: 'commentResolutionRequestTriggered';
104
+ COMMENT_RESOLUTION_RESULT: 'commentResolutionResult';
105
+ COMMENT_RESOLUTION_ERROR: 'commentResolutionError';
106
+ COMMENT_RESOLUTION_RESULT_FROM_CACHE: 'commentResolutionResultFromCache';
107
+ COMMENT_SAVE_REQUEST_FORMED: 'commentSaveRequestFormed';
108
+ COMMENT_SAVE_REQUEST_TRIGGERED: 'commentSaveRequestTriggered';
109
+ COMMENT_SAVE_RESULT: 'commentSaveResult';
110
+ COMMENT_SAVE_ERROR: 'commentSaveError';
111
+ COMMENT_DELETE_REQUEST_FORMED: 'commentDeleteRequestFormed';
112
+ COMMENT_DELETE_REQUEST_TRIGGERED: 'commentDeleteRequestTriggered';
113
+ COMMENT_DELETE_RESULT: 'commentDeleteResult';
114
+ COMMENT_DELETE_ERROR: 'commentDeleteError';
115
+ };
116
+ export type AttachmentResolverEvent = BaseResolverEvent<AttachmentResolverEventType, AttachmentResolverSource, AttachmentResolverModuleName>;
117
+ export declare enum AttachmentResolverModuleName {
118
+ }
119
+ export type AttachmentResolverEventType = {
120
+ ATTACHMENT_SAVE_REQUEST_FORMED: 'attachmentSaveRequestFormed';
121
+ ATTACHMENT_SAVE_REQUEST_TRIGGERED: 'attachmentSaveRequestTriggered';
122
+ ATTACHMENT_SAVE_RESULT: 'attachmentSaveResult';
123
+ ATTACHMENT_SAVE_ERROR: 'attachmentSaveError';
124
+ ATTACHMENT_DELETE_REQUEST_FORMED: 'attachmentDeleteRequestFormed';
125
+ ATTACHMENT_DELETE_REQUEST_TRIGGERED: 'attachmentDeleteRequestTriggered';
126
+ ATTACHMENT_DELETE_RESULT: 'attachmentDeleteResult';
127
+ ATTACHMENT_DELETE_ERROR: 'attachmentDeleteError';
128
+ };
129
+ export type ReactionResolverEvent = BaseResolverEvent<ReactionResolverEventType, ReactionResolverSource, ReactionResolverModuleName>;
130
+ export declare enum ReactionResolverModuleName {
131
+ SET_DOCUMENTS = "setDocuments",
132
+ GET_REACTION_ANNOTATIONS = "getReactionAnnotations"
133
+ }
134
+ export type ReactionResolverEventType = {
135
+ REACTION_RESOLUTION_REQUEST_FORMED: 'reactionResolutionRequestFormed';
136
+ REACTION_RESOLUTION_REQUEST_TRIGGERED: 'reactionResolutionRequestTriggered';
137
+ REACTION_RESOLUTION_RESULT: 'reactionResolutionResult';
138
+ REACTION_RESOLUTION_ERROR: 'reactionResolutionError';
139
+ REACTION_RESOLUTION_RESULT_FROM_CACHE: 'reactionResolutionResultFromCache';
140
+ REACTION_SAVE_REQUEST_FORMED: 'reactionSaveRequestFormed';
141
+ REACTION_SAVE_REQUEST_TRIGGERED: 'reactionSaveRequestTriggered';
142
+ REACTION_SAVE_RESULT: 'reactionSaveResult';
143
+ REACTION_SAVE_ERROR: 'reactionSaveError';
144
+ REACTION_DELETE_REQUEST_FORMED: 'reactionDeleteRequestFormed';
145
+ REACTION_DELETE_REQUEST_TRIGGERED: 'reactionDeleteRequestTriggered';
146
+ REACTION_DELETE_RESULT: 'reactionDeleteResult';
147
+ REACTION_DELETE_ERROR: 'reactionDeleteError';
148
+ };
149
+ export type ErrorEvent = {
150
+ event?: string;
151
+ sourceMethod?: string;
152
+ documentIds?: string[];
153
+ userId?: string;
154
+ timestamp?: number;
155
+ error?: string;
156
+ code?: string;
157
+ message?: string;
158
+ source?: string;
159
+ };
160
+ export declare enum InitUpdateMethodNames {
161
+ SET_DOCUMENTS = "setDocuments",
162
+ SET_ROOT_DOCUMENT = "setRootDocument",
163
+ SET_DOCUMENT_ID = "setDocumentId",
164
+ UNSET_DOCUMENT_ID = "unsetDocumentId",
165
+ UNSET_DOCUMENTS = "unsetDocuments",
166
+ SET_LOCATION = "setLocation",
167
+ SET_LOCATIONS = "setLocations",
168
+ SET_ROOT_LOCATION = "setRootLocation",
169
+ ADD_LOCATION = "addLocation",
170
+ REMOVE_LOCATION = "removeLocation",
171
+ REMOVE_LOCATIONS = "removeLocations",
172
+ UNSET_LOCATION_IDS = "unsetLocationIds",
173
+ REMOVE_LOCATIONS_SUCCESS = "removeLocationsSuccess"
174
+ }
175
+ export type InitUpdateEvent = {
176
+ event: string;
177
+ methodName?: string;
178
+ source?: string;
179
+ payload?: any;
180
+ };
@@ -0,0 +1,25 @@
1
+ import { CrdtEventTypes } from "../../utils/enums";
2
+ export type CrdtEventTypesMap = {
3
+ [CrdtEventTypes.UPDATE_DATA]: CrdtUpdateDataEvent;
4
+ };
5
+ export declare enum CrdtSource {
6
+ INTERNAL = "internal",
7
+ EXTERNAL = "external"
8
+ }
9
+ export declare enum CrdtMethodName {
10
+ UPDATE_DATA = "updateData"
11
+ }
12
+ export type CrdtUpdateDataEvent = {
13
+ methodName: string;
14
+ uniqueId: string;
15
+ timestamp: number;
16
+ source: string;
17
+ payload: CrdtUpdateDataPayload;
18
+ };
19
+ export type CrdtUpdateDataPayload = {
20
+ id: string;
21
+ data: unknown;
22
+ lastUpdatedBy: string;
23
+ sessionId?: string | null;
24
+ lastUpdate: string;
25
+ };
@@ -0,0 +1,60 @@
1
+ export interface CrdtVersion {
2
+ versionId: string;
3
+ versionName?: string;
4
+ state: Uint8Array | number[];
5
+ timestamp: number;
6
+ }
7
+ export interface CrdtVersionWithEncryptedState extends Omit<CrdtVersion, 'state'> {
8
+ encryptedState: string;
9
+ }
10
+ export interface CrdtUpdateDataQuery {
11
+ id: string;
12
+ state: Uint8Array | number[];
13
+ data?: unknown;
14
+ }
15
+ export interface CrdtOnDataChangeQuery {
16
+ id: string;
17
+ callback: (data: any) => void;
18
+ }
19
+ export interface CrdtGetDataQuery {
20
+ id: string;
21
+ }
22
+ export interface CrdtOnStateChangeQuery {
23
+ id: string;
24
+ callback: (data: any) => void;
25
+ }
26
+ export interface CrdtUpdateStateQuery {
27
+ id: string;
28
+ state: Uint8Array | number[];
29
+ }
30
+ export interface CrdtRegisterSyncUserQuery {
31
+ id: string;
32
+ }
33
+ export interface CrdtOnRegisteredUserChangeQuery {
34
+ id: string;
35
+ callback: (data: any) => void;
36
+ }
37
+ export interface CrdtSetPresenceQuery {
38
+ id: string;
39
+ }
40
+ export interface CrdtOnPresenceChangeQuery {
41
+ id: string;
42
+ callback: (data: any) => void;
43
+ }
44
+ export interface CrdtSaveVersionQuery {
45
+ id: string;
46
+ versionId: string;
47
+ versionName?: string;
48
+ state: Uint8Array | number[];
49
+ }
50
+ export interface CrdtGetVersionQuery {
51
+ id: string;
52
+ versionId: string;
53
+ }
54
+ export interface CrdtGetVersionsQuery {
55
+ id: string;
56
+ }
57
+ export interface CrdtDeleteVersionQuery {
58
+ id: string;
59
+ versionId: string;
60
+ }
@@ -7,4 +7,19 @@ export declare class CursorPosition {
7
7
  * Position left of cursor on viewer user's screen
8
8
  */
9
9
  left: number;
10
+ /**
11
+ * Scale factor of the parent element in X direction
12
+ * Used for transform handling
13
+ */
14
+ parentScaleX?: number;
15
+ /**
16
+ * Scale factor of the parent element in Y direction
17
+ * Used for transform handling
18
+ */
19
+ parentScaleY?: number;
20
+ /**
21
+ * Transform context information
22
+ * Used to handle transforms properly
23
+ */
24
+ transformContext?: any;
10
25
  }
@@ -75,6 +75,10 @@ export declare class CursorUser {
75
75
  * This is the color on the avatar border and live cursor, if these features are enabled.
76
76
  */
77
77
  color?: string;
78
+ /**
79
+ * This is the color on the avatar text.
80
+ */
81
+ textColor?: string;
78
82
  /**
79
83
  * Server Timestamp.
80
84
  *
@@ -115,4 +119,5 @@ export declare class CursorUser {
115
119
  */
116
120
  isAnonymous?: boolean;
117
121
  pageInfo: PageInfo;
122
+ initial?: string;
118
123
  }
@@ -0,0 +1,10 @@
1
+ export type CustomAnnotationDropdownType = 'multi' | 'single';
2
+ export declare class CustomAnnotationDropdownItem {
3
+ id: string;
4
+ label: string;
5
+ }
6
+ export declare class CustomAnnotationDropdownData {
7
+ type: CustomAnnotationDropdownType;
8
+ placeholder?: string;
9
+ data: CustomAnnotationDropdownItem[];
10
+ }
@@ -0,0 +1,10 @@
1
+ export declare class CustomCss {
2
+ /**
3
+ * Type of custom css
4
+ */
5
+ type: 'link' | 'styles';
6
+ /**
7
+ * Value of custom css
8
+ */
9
+ value: string;
10
+ }
@@ -13,6 +13,14 @@ export interface CustomStatus extends CustomFilter {
13
13
  svg?: string;
14
14
  iconUrl?: string;
15
15
  }
16
+ export interface CustomFilterOption {
17
+ id: string;
18
+ name: string;
19
+ selected: boolean;
20
+ }
21
+ export interface CustomFilters {
22
+ [key: string]: CustomFilterOption[];
23
+ }
16
24
  export interface CustomCategory extends CustomFilter {
17
25
  }
18
26
  export interface CustomCategoryMap {
@@ -0,0 +1,15 @@
1
+ export declare class CustomerMetadata {
2
+ customBranding?: CustomBranding;
3
+ }
4
+ export declare class CustomBranding {
5
+ logo?: {
6
+ logoMark?: {
7
+ lightUrl?: string;
8
+ darkUrl?: string;
9
+ };
10
+ wordMark?: {
11
+ lightUrl?: string;
12
+ darkUrl?: string;
13
+ };
14
+ };
15
+ }
@@ -0,0 +1,8 @@
1
+ import { DocumentMetadata } from "./document-metadata.model";
2
+ import { FolderMetadata } from "./folder-metadata.model";
3
+ export interface FetchDocumentsResponse {
4
+ data: Record<string, DocumentMetadata> | null;
5
+ }
6
+ export interface FetchFoldersResponse {
7
+ data: Record<string, FolderMetadata> | null;
8
+ }
@@ -11,6 +11,14 @@ export declare class DocumentIAM {
11
11
  * The document access type
12
12
  */
13
13
  documentAccessType: DocumentAccessType;
14
+ /**
15
+ * The access type of the document when document is inside organization
16
+ */
17
+ accessType: DocumentAccessType;
18
+ /**
19
+ * Flag to indicate if the document is disabled
20
+ */
21
+ disabled: boolean;
14
22
  /**
15
23
  * Features
16
24
  */
@@ -6,10 +6,34 @@ export declare class DocumentMetadata {
6
6
  * Unique document id generated from client document id
7
7
  */
8
8
  documentId?: string;
9
+ /**
10
+ * Folders
11
+ */
12
+ folderId?: string;
13
+ /**
14
+ * Velt folder id
15
+ */
16
+ veltFolderId?: string;
17
+ /**
18
+ * API key
19
+ */
20
+ apiKey?: string;
21
+ /**
22
+ * Organization id
23
+ */
24
+ organizationId?: string;
25
+ /**
26
+ * Client organization id
27
+ */
28
+ clientOrganizationId?: string;
9
29
  /**
10
30
  * Document id provided by client
11
31
  */
12
32
  clientDocumentId?: string | number;
33
+ /**
34
+ * Document name
35
+ */
36
+ documentName?: string;
13
37
  /**
14
38
  * Page metadata
15
39
  */
@@ -24,4 +48,8 @@ export declare class DocumentMetadata {
24
48
  * Document creator
25
49
  */
26
50
  creator?: User;
51
+ [key: string]: any;
52
+ }
53
+ export interface DocumentMetadatas {
54
+ [documentId: string]: DocumentMetadata;
27
55
  }
@@ -3,10 +3,20 @@ export declare class DocumentPaths {
3
3
  * The document's unique identifier.
4
4
  */
5
5
  documentId?: string;
6
+ folderId?: string;
7
+ locationId?: string;
8
+ allDocuments?: boolean;
9
+ veltFolderId?: string;
10
+ folder?: string;
6
11
  /**
7
12
  * Presence path.
8
13
  */
9
14
  presence?: string;
15
+ /**
16
+ * User config path.
17
+ */
18
+ userConfig?: string;
19
+ docs?: string;
10
20
  /**
11
21
  * Cursor path.
12
22
  */
@@ -23,14 +33,42 @@ export declare class DocumentPaths {
23
33
  * Comment path.
24
34
  */
25
35
  comment?: string;
36
+ /**
37
+ * Multi thread path.
38
+ */
39
+ multiThread?: string;
26
40
  /**
27
41
  * Huddle path.
28
42
  */
29
43
  audioHuddle?: string;
44
+ /**
45
+ * Heartbeat path.
46
+ */
47
+ heartbeat?: string;
48
+ /**
49
+ * Heartbeat by document path.
50
+ */
51
+ heartbeatByDocument?: string;
30
52
  /**
31
53
  * Document Id provided by the user.
32
54
  */
33
55
  clientDocumentId?: string;
56
+ /**
57
+ * Organization Id.
58
+ */
59
+ organizationId?: string;
60
+ /**
61
+ * Client organization Id.
62
+ */
63
+ clientOrganizationId?: string;
64
+ /**
65
+ * Organization metadata path.
66
+ */
67
+ organizationMetadata?: string;
68
+ /**
69
+ * Organization groups path.
70
+ */
71
+ organizationGroups?: string;
34
72
  /**
35
73
  * Group contacts path.
36
74
  */
@@ -43,6 +81,10 @@ export declare class DocumentPaths {
43
81
  * User login path.
44
82
  */
45
83
  logins?: string;
84
+ /**
85
+ * CRDT path.
86
+ */
87
+ crdt?: string;
46
88
  /**
47
89
  * Selection path.
48
90
  */
@@ -66,7 +108,11 @@ export declare class DocumentPaths {
66
108
  /**
67
109
  * IAM (Identity and Access Management) path.
68
110
  */
69
- iam?: string;
111
+ workspaceIam?: string;
112
+ /**
113
+ * Organization IAM (Identity and Access Management) path.
114
+ */
115
+ organizationIam?: string;
70
116
  /**
71
117
  * Document IAM (Identity and Access Management) path.
72
118
  */
@@ -98,4 +144,8 @@ export declare class DocumentPaths {
98
144
  customerMetadata?: string;
99
145
  views?: string;
100
146
  notifications?: string;
147
+ organizationNotifications?: string;
148
+ organizationNotificationsWithDocumentId?: string;
149
+ organizationNotificationsUsers?: string;
150
+ organizationNotificationsLastNotificationTimestamp?: string;
101
151
  }
@@ -0,0 +1,63 @@
1
+ import { DocumentMetadata } from "./document-metadata.model";
2
+ export interface Document {
3
+ id: string;
4
+ metadata?: DocumentMetadata;
5
+ }
6
+ export interface SetDocumentsContext {
7
+ access: {
8
+ [key: string]: Array<string | number>;
9
+ };
10
+ accessFields?: Array<string>;
11
+ }
12
+ export interface SetDocumentsRequestOptions {
13
+ organizationId?: string;
14
+ folderId?: string;
15
+ allDocuments?: boolean;
16
+ locationId?: string;
17
+ rootDocumentId?: string;
18
+ context?: SetDocumentsContext;
19
+ }
20
+ export interface UpdateDocumentsRequest<T = unknown> {
21
+ organizationId?: string;
22
+ folderId?: string;
23
+ documents?: UpdateDocumentMetadata<T>[];
24
+ }
25
+ export interface UpdateDocumentMetadata<T = unknown> {
26
+ documentId: string;
27
+ [key: string]: T | string;
28
+ }
29
+ export interface UpdateLocationsRequest<T = unknown> {
30
+ organizationId?: string;
31
+ documentIds?: string[];
32
+ locations?: UpdateLocationMetadata<T>[];
33
+ }
34
+ export interface UpdateLocationMetadata<T = unknown> {
35
+ id: string;
36
+ [key: string]: T | string;
37
+ }
38
+ export interface FetchDocumentsRequest {
39
+ organizationId?: string;
40
+ documentIds?: string[];
41
+ folderId?: string;
42
+ allDocuments?: boolean;
43
+ }
44
+ export interface FetchLocationsRequest {
45
+ organizationId?: string;
46
+ documentIds?: string[];
47
+ folderId?: string;
48
+ allDocuments?: boolean;
49
+ }
50
+ export interface FetchFoldersRequest {
51
+ organizationId?: string;
52
+ folderId?: string;
53
+ }
54
+ export interface FolderConfig {
55
+ folderId?: string;
56
+ allDocuments?: boolean;
57
+ locationId?: string;
58
+ veltFolderId?: string;
59
+ }
60
+ export interface OrganizationConfig {
61
+ organizationId: string;
62
+ clientOrganizationId: string;
63
+ }
@@ -0,0 +1,12 @@
1
+ export interface EncryptConfig<T = any> {
2
+ data: T;
3
+ type?: string;
4
+ }
5
+ export interface DecryptConfig<R = any> {
6
+ data: R;
7
+ type?: string;
8
+ }
9
+ export interface VeltEncryptionProvider<T = any, R = any> {
10
+ encrypt: (config: EncryptConfig<T>) => Promise<R>;
11
+ decrypt: (config: DecryptConfig<R>) => Promise<T>;
12
+ }
@@ -0,0 +1,32 @@
1
+ import { DocumentMetadata } from "./document-metadata.model";
2
+ import { SetDocumentsContext } from "./document.data.model";
3
+ import { FolderMetadata } from "./folder-metadata.model";
4
+ import { Location } from "./location.model";
5
+ import { OrganizationMetadata } from "./organization-metadata.model";
6
+ import { User } from "./user.data.model";
7
+ export interface VeltEventMetadata {
8
+ organization?: OrganizationMetadata | null;
9
+ documents?: DocumentMetadata[];
10
+ locations?: Location[];
11
+ folderId?: string;
12
+ }
13
+ export interface VeltDebugInfo {
14
+ veltVersion?: string;
15
+ apiKey?: string;
16
+ serverMap?: {
17
+ organization?: OrganizationMetadata;
18
+ documents?: DocumentMetadata[];
19
+ locations?: Location[];
20
+ folder?: FolderMetadata;
21
+ user?: User;
22
+ accessFields?: Array<string>;
23
+ };
24
+ clientMap?: {
25
+ organization?: OrganizationMetadata;
26
+ documents?: DocumentMetadata[];
27
+ locations?: Location[];
28
+ folder?: FolderMetadata;
29
+ user?: User;
30
+ context?: SetDocumentsContext;
31
+ };
32
+ }
@@ -0,0 +1,40 @@
1
+ export declare class FolderMetadata {
2
+ folderId?: string;
3
+ /**
4
+ * Velt folder id
5
+ */
6
+ veltFolderId?: string;
7
+ /**
8
+ * Parent folder id
9
+ */
10
+ parentFolderId?: string;
11
+ /**
12
+ * Velt parent folder id
13
+ */
14
+ veltParentFolderId?: string;
15
+ /**
16
+ * Created at
17
+ */
18
+ createdAt?: number;
19
+ /**
20
+ * Last updated
21
+ */
22
+ lastUpdated?: number;
23
+ /**
24
+ * API key
25
+ */
26
+ apiKey?: string;
27
+ /**
28
+ * Organization id
29
+ */
30
+ organizationId?: string;
31
+ /**
32
+ * Client organization id
33
+ */
34
+ clientOrganizationId?: string;
35
+ /**
36
+ * Folder name
37
+ */
38
+ folderName?: string;
39
+ [key: string]: any;
40
+ }