@veltdev/sdk 4.0.0-beta.20 → 4.0.0-beta.21

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.
@@ -4,4 +4,6 @@ export declare class BaseMetadata {
4
4
  clientDocumentId?: string;
5
5
  organizationId?: string;
6
6
  clientOrganizationId?: string;
7
+ folderId?: string;
8
+ veltFolderId?: string;
7
9
  }
@@ -9,8 +9,10 @@ import { User } from "./user.data.model";
9
9
  export interface RequestOptions {
10
10
  organizationId?: string;
11
11
  documentId?: string;
12
+ folderId?: string;
12
13
  filters?: any;
13
14
  documentIds?: string[];
15
+ allDocuments?: boolean;
14
16
  }
15
17
  export interface UpdatePriorityRequest {
16
18
  annotationId: string;
@@ -63,6 +65,9 @@ export interface CommentRequestQuery {
63
65
  documentIds?: string[];
64
66
  locationIds?: string[];
65
67
  statusIds?: string[];
68
+ folderId?: string;
69
+ allDocuments?: boolean;
70
+ locationId?: string;
66
71
  }
67
72
  export interface SubscribeCommentAnnotationRequest {
68
73
  annotationId: string;
@@ -161,3 +166,18 @@ export interface ToggleReactionRequest {
161
166
  };
162
167
  options?: RequestOptions;
163
168
  }
169
+ export interface FetchCommentAnnotationsRequest {
170
+ createdAfter?: number;
171
+ createdBefore?: number;
172
+ updatedAfter?: number;
173
+ updatedBefore?: number;
174
+ statusIds?: string[];
175
+ order?: 'asc' | 'desc';
176
+ pageToken?: string;
177
+ allDocuments?: boolean;
178
+ pageSize?: number;
179
+ organizationId?: string;
180
+ locationId?: string;
181
+ documentIds?: string[];
182
+ folderId?: string;
183
+ }
@@ -5,7 +5,9 @@ import { AddAttachmentResponse } from "./comment-actions.data.model";
5
5
  import { CommentAnnotation, UpdateContextConfig } from "./comment-annotation.data.model";
6
6
  import { Comment } from "./comment.data.model";
7
7
  import { CustomPriority, CustomStatus } from "./custom-filter.data.model";
8
+ import { DocumentMetadata } from "./document-metadata.model";
8
9
  import { VeltEventMetadata } from "./event-metadata.data.model";
10
+ import { FolderMetadata } from "./folder-metadata.model";
9
11
  import { Location } from "./location.model";
10
12
  import { ReactionAnnotation } from "./reaction-annotation.data.model";
11
13
  import { RecordedData } from "./recorder.model";
@@ -129,6 +131,17 @@ export interface DeleteCommentAnnotationEvent {
129
131
  export interface GetCommentAnnotationsResponse {
130
132
  data: Record<string, CommentAnnotation[]> | null;
131
133
  }
134
+ export interface FetchCommentAnnotationsResponse extends GetCommentAnnotationsResponse {
135
+ nextPageToken: string;
136
+ }
137
+ export interface FetchDocumentsResponse {
138
+ data: Record<string, DocumentMetadata[]> | null;
139
+ nextPageToken: string;
140
+ }
141
+ export interface FetchFoldersResponse {
142
+ data: Record<string, FolderMetadata[]> | null;
143
+ nextPageToken: string;
144
+ }
132
145
  export interface GetCommentAnnotationsCountResponse {
133
146
  data: Record<string, CommentAnnotationsCount> | null;
134
147
  }
@@ -6,6 +6,14 @@ 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;
9
17
  /**
10
18
  * API key
11
19
  */
@@ -5,4 +5,23 @@ export interface Document {
5
5
  }
6
6
  export interface SetDocumentsRequestOptions {
7
7
  organizationId?: string;
8
+ folderId?: string;
9
+ allDocuments?: boolean;
10
+ locationId?: string;
11
+ }
12
+ export interface FetchDocumentsRequest {
13
+ organizationId?: string;
14
+ documentIds?: string[];
15
+ folderId?: string;
16
+ allDocuments?: boolean;
17
+ }
18
+ export interface FetchFoldersRequest {
19
+ organizationId?: string;
20
+ folderId?: string;
21
+ }
22
+ export interface FolderConfig {
23
+ folderId?: string;
24
+ allDocuments?: boolean;
25
+ locationId?: string;
26
+ veltFolderId?: string;
8
27
  }
@@ -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
+ }
@@ -10,6 +10,7 @@ export declare class Constants {
10
10
  static DEFAULT_QUERY_HASH: string;
11
11
  static LISTENER_BATCH_SIZE: number;
12
12
  static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
13
+ static FIREBASE_PARTIAL_PATH_FOLDERS: string;
13
14
  static FIREBASE_PARTIAL_PATH_DOCS: string;
14
15
  static FIREBASE_PARTIAL_PATH_PRESENCE: string;
15
16
  static FIREBASE_PARTIAL_PATH_ORGANIZATION_USERS: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk",
3
- "version": "4.0.0-beta.20",
3
+ "version": "4.0.0-beta.21",
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": [