@veltdev/sdk 3.0.86 → 4.0.0-beta.1
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.
- package/app/models/data/area-annotation.data.model.d.ts +3 -3
- package/app/models/data/base-metadata.data.model.d.ts +1 -0
- package/app/models/data/comment-actions.data.model.d.ts +4 -0
- package/app/models/data/comment-events.data.model.d.ts +9 -0
- package/app/models/data/config.data.model.d.ts +10 -0
- package/app/models/data/document-metadata.model.d.ts +15 -0
- package/app/models/data/document-paths.data.model.d.ts +1 -0
- package/app/models/data/organization-metadata.model.d.ts +4 -0
- package/app/models/data/recorder-annotation.data.model.d.ts +4 -0
- package/app/models/data/user-iam.data.model.d.ts +2 -0
- package/app/models/data/views.data.model.d.ts +37 -23
- package/app/utils/constants.d.ts +2 -0
- package/package.json +1 -1
- package/velt.js +2 -2
|
@@ -54,9 +54,6 @@ export declare class AreaAnnotation {
|
|
|
54
54
|
targetAnnotations: AreaTargetAnnotation[];
|
|
55
55
|
metadata?: AreaMetadata;
|
|
56
56
|
}
|
|
57
|
-
export declare class AreaMetadata extends BaseMetadata {
|
|
58
|
-
[key: string]: any;
|
|
59
|
-
}
|
|
60
57
|
export declare class AreaTargetAnnotation {
|
|
61
58
|
/**
|
|
62
59
|
* Type of the annotation (ex. comment, tag etc.)
|
|
@@ -77,3 +74,6 @@ export declare class AreaProperty {
|
|
|
77
74
|
handle2?: any;
|
|
78
75
|
coordinates?: any;
|
|
79
76
|
}
|
|
77
|
+
export declare class AreaMetadata extends BaseMetadata {
|
|
78
|
+
[key: string]: any;
|
|
79
|
+
}
|
|
@@ -10,6 +10,7 @@ export interface RequestOptions {
|
|
|
10
10
|
organizationId?: string;
|
|
11
11
|
documentId?: string;
|
|
12
12
|
filters?: any;
|
|
13
|
+
documentIds?: string[];
|
|
13
14
|
}
|
|
14
15
|
export interface UpdatePriorityRequest {
|
|
15
16
|
annotationId: string;
|
|
@@ -61,6 +62,9 @@ export interface DeleteCommentAnnotationRequest {
|
|
|
61
62
|
export interface GetCommentAnnotationRequest {
|
|
62
63
|
options?: RequestOptions;
|
|
63
64
|
}
|
|
65
|
+
export interface GetCommentAnnotationsCountRequest {
|
|
66
|
+
options?: RequestOptions;
|
|
67
|
+
}
|
|
64
68
|
export interface SubscribeCommentAnnotationRequest {
|
|
65
69
|
annotationId: string;
|
|
66
70
|
options?: RequestOptions;
|
|
@@ -130,6 +130,15 @@ export interface GetCommentAnnotationEvent {
|
|
|
130
130
|
commentAnnotations: CommentAnnotation[];
|
|
131
131
|
metadata: VeltEventMetadata;
|
|
132
132
|
}
|
|
133
|
+
export interface GetCommentAnnotationResponse {
|
|
134
|
+
[documentId: string]: CommentAnnotation[];
|
|
135
|
+
}
|
|
136
|
+
export interface GetCommentAnnotationsCountResponse {
|
|
137
|
+
[documentId: string]: {
|
|
138
|
+
total: number;
|
|
139
|
+
unread: number;
|
|
140
|
+
};
|
|
141
|
+
}
|
|
133
142
|
export interface SubscribeCommentAnnotationEvent {
|
|
134
143
|
annotationId: string;
|
|
135
144
|
commentAnnotation: CommentAnnotation;
|
|
@@ -43,7 +43,17 @@ export declare class Config {
|
|
|
43
43
|
* prefers-color-scheme media query to set the global theme of our components.
|
|
44
44
|
*/
|
|
45
45
|
usePrefersColorScheme?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* To enable/disable advanced queries.
|
|
48
|
+
*
|
|
49
|
+
* Default: false
|
|
50
|
+
*/
|
|
51
|
+
advancedQueriesDisabled?: boolean;
|
|
46
52
|
}
|
|
47
53
|
export interface ExtendedFirebaseOptions extends FirebaseOptions {
|
|
48
54
|
storeDbId: string;
|
|
49
55
|
}
|
|
56
|
+
export interface AdvancedQueries {
|
|
57
|
+
advancedQueriesEnabled: boolean;
|
|
58
|
+
advancedQueriesEnabledTime: number;
|
|
59
|
+
}
|
|
@@ -6,6 +6,18 @@ export declare class DocumentMetadata {
|
|
|
6
6
|
* Unique document id generated from client document id
|
|
7
7
|
*/
|
|
8
8
|
documentId?: string;
|
|
9
|
+
/**
|
|
10
|
+
* API key
|
|
11
|
+
*/
|
|
12
|
+
apiKey?: string;
|
|
13
|
+
/**
|
|
14
|
+
* Organization id
|
|
15
|
+
*/
|
|
16
|
+
organizationId?: string;
|
|
17
|
+
/**
|
|
18
|
+
* Client organization id
|
|
19
|
+
*/
|
|
20
|
+
clientOrganizationId?: string;
|
|
9
21
|
/**
|
|
10
22
|
* Document id provided by client
|
|
11
23
|
*/
|
|
@@ -30,3 +42,6 @@ export declare class DocumentMetadata {
|
|
|
30
42
|
creator?: User;
|
|
31
43
|
[key: string]: any;
|
|
32
44
|
}
|
|
45
|
+
export interface DocumentMetadatas {
|
|
46
|
+
[documentId: string]: DocumentMetadata;
|
|
47
|
+
}
|
|
@@ -13,6 +13,10 @@ export declare class RecorderAnnotation {
|
|
|
13
13
|
* Auto generated.
|
|
14
14
|
*/
|
|
15
15
|
annotationId: string;
|
|
16
|
+
/**
|
|
17
|
+
* Connected comment annotation id of reaction annotation
|
|
18
|
+
*/
|
|
19
|
+
commentAnnotationId?: string;
|
|
16
20
|
/**
|
|
17
21
|
* The user who created this recorder pin annotation.
|
|
18
22
|
*
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { BaseMetadata } from "./base-metadata.data.model";
|
|
1
2
|
import { UserContact } from "./user-contact.data.model";
|
|
2
3
|
import { UserRole } from "./user-role.data.model";
|
|
3
4
|
import { User } from "./user.data.model";
|
|
@@ -33,4 +34,5 @@ export declare class UserIAM {
|
|
|
33
34
|
groups?: {
|
|
34
35
|
[groupId: string]: boolean;
|
|
35
36
|
};
|
|
37
|
+
metadata?: BaseMetadata;
|
|
36
38
|
}
|
|
@@ -1,19 +1,7 @@
|
|
|
1
|
+
import { BaseMetadata } from "./base-metadata.data.model";
|
|
1
2
|
import { Location } from "./location.model";
|
|
2
3
|
export declare class Views {
|
|
3
|
-
comment?:
|
|
4
|
-
[commentAnnotationId: string]: {
|
|
5
|
-
views: {
|
|
6
|
-
[userSnippylyId: string]: View;
|
|
7
|
-
};
|
|
8
|
-
comments: {
|
|
9
|
-
[commentId: string]: {
|
|
10
|
-
views: {
|
|
11
|
-
[userSnippylyId: string]: View;
|
|
12
|
-
};
|
|
13
|
-
};
|
|
14
|
-
};
|
|
15
|
-
};
|
|
16
|
-
};
|
|
4
|
+
comment?: CommentViews;
|
|
17
5
|
notification?: {
|
|
18
6
|
[notificationId: string]: {
|
|
19
7
|
views: {
|
|
@@ -22,17 +10,10 @@ export declare class Views {
|
|
|
22
10
|
};
|
|
23
11
|
};
|
|
24
12
|
documentViews?: {
|
|
25
|
-
[documentId: string]:
|
|
26
|
-
users: ViewsByUser;
|
|
27
|
-
day: ViewsByDate;
|
|
28
|
-
};
|
|
13
|
+
[documentId: string]: DocumentViews;
|
|
29
14
|
};
|
|
30
15
|
locationViews?: {
|
|
31
|
-
[locationId: string]:
|
|
32
|
-
location: Location;
|
|
33
|
-
users: ViewsByUser;
|
|
34
|
-
day: ViewsByDate;
|
|
35
|
-
};
|
|
16
|
+
[locationId: string]: LocationViews;
|
|
36
17
|
};
|
|
37
18
|
}
|
|
38
19
|
export declare class View {
|
|
@@ -48,3 +29,36 @@ export declare class ViewsByUser {
|
|
|
48
29
|
[date: string]: View;
|
|
49
30
|
};
|
|
50
31
|
}
|
|
32
|
+
export declare class CommentViews {
|
|
33
|
+
[commentAnnotationId: string]: CommentAnnotationViews;
|
|
34
|
+
}
|
|
35
|
+
export declare class LocationViewsMap {
|
|
36
|
+
[locationId: string]: LocationViews;
|
|
37
|
+
}
|
|
38
|
+
export declare class CommentAnnotationViews {
|
|
39
|
+
views: {
|
|
40
|
+
[userSnippylyId: string]: View;
|
|
41
|
+
};
|
|
42
|
+
comments: {
|
|
43
|
+
[commentId: string]: {
|
|
44
|
+
views: {
|
|
45
|
+
[userSnippylyId: string]: View;
|
|
46
|
+
};
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
metadata?: BaseMetadata;
|
|
50
|
+
}
|
|
51
|
+
export declare class DocumentViewsMap {
|
|
52
|
+
[documentId: string]: DocumentViews;
|
|
53
|
+
}
|
|
54
|
+
export declare class DocumentViews {
|
|
55
|
+
users: ViewsByUser;
|
|
56
|
+
day: ViewsByDate;
|
|
57
|
+
metadata?: BaseMetadata;
|
|
58
|
+
}
|
|
59
|
+
export declare class LocationViews {
|
|
60
|
+
location: Location;
|
|
61
|
+
users: ViewsByUser;
|
|
62
|
+
day: ViewsByDate;
|
|
63
|
+
metadata?: BaseMetadata;
|
|
64
|
+
}
|
package/app/utils/constants.d.ts
CHANGED
|
@@ -270,6 +270,7 @@ export declare class Constants {
|
|
|
270
270
|
VELT_RECORDER_DISABLED: string;
|
|
271
271
|
VELT_ANNOTATION_DRAFT: string;
|
|
272
272
|
VELT_ANNOTATION_EDIT_COMMENT: string;
|
|
273
|
+
VELT_DOCUMENT_ID: string;
|
|
273
274
|
VELT_LOCATION: string;
|
|
274
275
|
VELT_LOCATION_ID: string;
|
|
275
276
|
VELT_THEME: string;
|
|
@@ -352,6 +353,7 @@ export declare class Constants {
|
|
|
352
353
|
VELT_USER: string;
|
|
353
354
|
VELT_USER_FORCE_RE_LOGGED_IN: string;
|
|
354
355
|
VELT_VERSION: string;
|
|
356
|
+
VELT_ADVANCED_QUERIES: string;
|
|
355
357
|
};
|
|
356
358
|
static NON_NESTABLE_ELEMENTS: {
|
|
357
359
|
[tag: string]: boolean;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/sdk",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0-beta.1",
|
|
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": [
|