@veltdev/sdk-staging 4.3.0-beta.8 → 4.3.0
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/comment-events.data.model.d.ts +1 -1
- package/app/models/data/comment-resolver.data.model.d.ts +6 -6
- package/app/models/data/contact-utils.data.model.d.ts +2 -2
- package/app/models/data/core-events.data.model.d.ts +10 -0
- package/app/models/data/organization-groups.data.model.d.ts +2 -2
- package/app/models/data/reaction-resolver.data.model.d.ts +6 -6
- package/app/models/data/recorder-annotation.data.model.d.ts +3 -6
- package/app/models/data/recorder-events.data.model.d.ts +4 -8
- package/app/models/element/comment-element.model.d.ts +20 -1
- package/app/models/element/recorder-element.model.d.ts +20 -3
- package/app/utils/enums.d.ts +3 -0
- package/models.d.ts +3 -0
- package/package.json +1 -1
- package/velt.js +2 -2
|
@@ -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
|
|
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:
|
|
7
|
-
save: (request:
|
|
8
|
-
delete: (request:
|
|
6
|
+
get: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
|
|
7
|
+
save: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
|
|
8
|
+
delete: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
|
|
9
9
|
config?: ResolverConfig;
|
|
10
10
|
}
|
|
11
|
-
export interface
|
|
11
|
+
export interface GetCommentResolverRequest {
|
|
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
|
|
18
|
+
export interface DeleteCommentResolverRequest {
|
|
19
19
|
commentAnnotationId: string;
|
|
20
20
|
metadata?: BaseMetadata;
|
|
21
21
|
event?: ResolverActions;
|
|
22
22
|
}
|
|
23
|
-
export interface
|
|
23
|
+
export interface SaveCommentResolverRequest {
|
|
24
24
|
commentAnnotation: {
|
|
25
25
|
[key: string]: PartialCommentAnnotation;
|
|
26
26
|
};
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { UserGroup } from "./organization-groups.data.model";
|
|
2
2
|
import { User } from "./user.data.model";
|
|
3
3
|
export interface GetContactListResponse {
|
|
4
4
|
organizationUsers?: User[];
|
|
5
5
|
folderUsers?: User[];
|
|
6
6
|
documentUsers?: User[];
|
|
7
|
-
userGroups?:
|
|
7
|
+
userGroups?: UserGroup[];
|
|
8
8
|
updatedContactList?: User[];
|
|
9
9
|
}
|
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
import { CoreEventTypes } from "../../utils/enums";
|
|
2
2
|
import { VeltButtonClickEvent } from "./button.data.model";
|
|
3
|
+
import { User } from "./user.data.model";
|
|
3
4
|
export type CoreEventTypesMap = {
|
|
4
5
|
[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;
|
|
5
15
|
};
|
|
@@ -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:
|
|
7
|
-
save: (request:
|
|
8
|
-
delete: (request:
|
|
6
|
+
get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
|
|
7
|
+
save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
|
|
8
|
+
delete: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
|
|
9
9
|
config?: ResolverConfig;
|
|
10
10
|
}
|
|
11
|
-
export interface
|
|
11
|
+
export interface GetReactionResolverRequest {
|
|
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
|
|
18
|
+
export interface DeleteReactionResolverRequest {
|
|
19
19
|
reactionAnnotationId: string;
|
|
20
20
|
metadata?: BaseMetadata;
|
|
21
21
|
event?: ResolverActions;
|
|
22
22
|
}
|
|
23
|
-
export interface
|
|
23
|
+
export interface SaveReactionResolverRequest {
|
|
24
24
|
reactionAnnotation: {
|
|
25
25
|
[key: string]: PartialReactionAnnotation;
|
|
26
26
|
};
|
|
@@ -197,6 +197,8 @@ declare class RecorderDataAsset {
|
|
|
197
197
|
thumbnailUrl?: string;
|
|
198
198
|
}
|
|
199
199
|
export declare class RecorderData {
|
|
200
|
+
recorderId: string;
|
|
201
|
+
metadata?: RecorderMetadata;
|
|
200
202
|
assets: RecorderDataAsset[];
|
|
201
203
|
transcription: RecorderDataTranscription;
|
|
202
204
|
}
|
|
@@ -206,11 +208,6 @@ export interface RecorderRequestQuery {
|
|
|
206
208
|
export interface GetRecordingDataResponse {
|
|
207
209
|
data: Record<string, RecorderData> | null;
|
|
208
210
|
}
|
|
209
|
-
export interface GetRecordingsResponse {
|
|
210
|
-
data: Record<string, RecorderAnnotationData> | null;
|
|
211
|
-
}
|
|
212
|
-
export declare class RecorderAnnotationData extends RecorderAnnotation {
|
|
213
|
-
transcriptionData: RecorderDataTranscription;
|
|
214
|
-
assets: RecorderDataAsset[];
|
|
211
|
+
export interface GetRecordingsResponse extends RecorderData {
|
|
215
212
|
}
|
|
216
213
|
export {};
|
|
@@ -1,14 +1,10 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { RecorderAnnotation, RecorderData } from "../../models/data/recorder-annotation.data.model";
|
|
1
|
+
import { RecorderData } from "../../models/data/recorder-annotation.data.model";
|
|
3
2
|
import { RecorderEventTypes } from "../../utils/enums";
|
|
4
|
-
export interface TranscriptionDoneEvent {
|
|
5
|
-
data: Record<string, RecorderData> | null;
|
|
3
|
+
export interface TranscriptionDoneEvent extends RecorderData {
|
|
6
4
|
}
|
|
7
|
-
export interface RecordingDoneEvent {
|
|
8
|
-
data: Record<string, RecordedData> | null;
|
|
5
|
+
export interface RecordingDoneEvent extends RecorderData {
|
|
9
6
|
}
|
|
10
|
-
export interface RecordingDeleteEvent {
|
|
11
|
-
data: Record<string, RecorderAnnotation> | null;
|
|
7
|
+
export interface RecordingDeleteEvent extends RecorderData {
|
|
12
8
|
}
|
|
13
9
|
export type RecorderEventTypesMap = {
|
|
14
10
|
[RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
|
|
@@ -1103,6 +1103,15 @@ export declare class CommentElement {
|
|
|
1103
1103
|
*/
|
|
1104
1104
|
public disableSvgAsImg: () => void;
|
|
1105
1105
|
|
|
1106
|
+
/**
|
|
1107
|
+
* To enable full expanded
|
|
1108
|
+
*/
|
|
1109
|
+
public enableFullExpanded: () => void;
|
|
1110
|
+
|
|
1111
|
+
/**
|
|
1112
|
+
* To disable full expanded
|
|
1113
|
+
*/
|
|
1114
|
+
public disableFullExpanded: () => void;
|
|
1106
1115
|
constructor();
|
|
1107
1116
|
/**
|
|
1108
1117
|
* Subscribe to comments on the current document.
|
|
@@ -2187,4 +2196,14 @@ export declare class CommentElement {
|
|
|
2187
2196
|
* To disable svg as img
|
|
2188
2197
|
*/
|
|
2189
2198
|
private _disableSvgAsImg;
|
|
2190
|
-
|
|
2199
|
+
|
|
2200
|
+
/**
|
|
2201
|
+
* To enable full expanded
|
|
2202
|
+
*/
|
|
2203
|
+
private _enableFullExpanded;
|
|
2204
|
+
|
|
2205
|
+
/**
|
|
2206
|
+
* To disable full expanded
|
|
2207
|
+
*/
|
|
2208
|
+
private _disableFullExpanded;
|
|
2209
|
+
}
|
|
@@ -2,12 +2,16 @@
|
|
|
2
2
|
import { Observable } from "rxjs";
|
|
3
3
|
import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse, GetRecordingsResponse } from "../data/recorder-annotation.data.model";
|
|
4
4
|
import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
|
|
5
|
+
import { RecordedData } from "../data/recorder.model";
|
|
5
6
|
|
|
6
7
|
export declare class RecorderElement {
|
|
7
8
|
|
|
8
9
|
initRecording: (type: string, panelId?: string) => any;
|
|
9
10
|
|
|
10
|
-
|
|
11
|
+
/**
|
|
12
|
+
* @deprecated Use on('recordingDone') method instead
|
|
13
|
+
*/
|
|
14
|
+
onRecordedData: () => Observable<RecordedData | null>;
|
|
11
15
|
|
|
12
16
|
/**
|
|
13
17
|
* To enable recording countdown
|
|
@@ -41,7 +45,7 @@ export declare class RecorderElement {
|
|
|
41
45
|
public on: <T extends keyof RecorderEventTypesMap>(action: T) => Observable<RecorderEventTypesMap[T]>;
|
|
42
46
|
|
|
43
47
|
/**
|
|
44
|
-
*
|
|
48
|
+
* @deprecated Use fetchRecordings() method instead
|
|
45
49
|
*/
|
|
46
50
|
getRecordingData: (query: RecorderRequestQuery) => Promise<GetRecordingDataResponse>;
|
|
47
51
|
|
|
@@ -58,12 +62,20 @@ export declare class RecorderElement {
|
|
|
58
62
|
/**
|
|
59
63
|
* To get recordings
|
|
60
64
|
*/
|
|
61
|
-
getRecordings: (query?: RecorderRequestQuery) => Observable<GetRecordingsResponse>;
|
|
65
|
+
getRecordings: (query?: RecorderRequestQuery) => Observable<GetRecordingsResponse[]>;
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* To fetch recordings
|
|
69
|
+
*/
|
|
70
|
+
fetchRecordings: (query: RecorderRequestQuery) => Promise<GetRecordingsResponse[]>;
|
|
62
71
|
|
|
63
72
|
constructor();
|
|
64
73
|
|
|
65
74
|
private _initRecording;
|
|
66
75
|
|
|
76
|
+
/**
|
|
77
|
+
* @deprecated Use on('recordingDone') method instead
|
|
78
|
+
*/
|
|
67
79
|
private _onRecordedData;
|
|
68
80
|
|
|
69
81
|
/**
|
|
@@ -116,4 +128,9 @@ export declare class RecorderElement {
|
|
|
116
128
|
* To get recordings
|
|
117
129
|
*/
|
|
118
130
|
private _getRecordings;
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* To fetch recordings
|
|
134
|
+
*/
|
|
135
|
+
private _fetchRecordings;
|
|
119
136
|
}
|
package/app/utils/enums.d.ts
CHANGED
|
@@ -60,6 +60,9 @@ export declare const RecorderEventTypes: {
|
|
|
60
60
|
};
|
|
61
61
|
export declare const CoreEventTypes: {
|
|
62
62
|
readonly VELT_BUTTON_CLICK: "veltButtonClick";
|
|
63
|
+
readonly USER_UPDATE: "userUpdate";
|
|
64
|
+
readonly DOCUMENT_INIT: "documentInit";
|
|
65
|
+
readonly ERROR: "error";
|
|
63
66
|
};
|
|
64
67
|
export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
|
|
65
68
|
export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
|
package/models.d.ts
CHANGED
|
@@ -9,6 +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';
|
|
12
13
|
export * from './app/models/data/comment-utils.data.model';
|
|
13
14
|
export * from './app/models/data/contact-utils.data.model';
|
|
14
15
|
export * from './app/models/data/config.data.model';
|
|
@@ -62,6 +63,7 @@ export * from './app/models/data/comment-sidebar-config.model';
|
|
|
62
63
|
export * from './app/models/data/views.data.model';
|
|
63
64
|
export * from './app/models/data/autocomplete.data.model';
|
|
64
65
|
export * from './app/models/data/reaction-annotation.data.model';
|
|
66
|
+
export * from './app/models/data/reaction-resolver.data.model';
|
|
65
67
|
export * from './app/models/data/reaction.data.model';
|
|
66
68
|
export * from './app/models/data/organization-groups.data.model';
|
|
67
69
|
export * from './app/models/data/organization-metadata.model';
|
|
@@ -69,3 +71,4 @@ export * from './app/models/data/user-organization.data.model';
|
|
|
69
71
|
export * from './app/models/data/event-metadata.data.model';
|
|
70
72
|
export * from './app/models/data/user-resolver.data.model';
|
|
71
73
|
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/sdk-staging",
|
|
3
|
-
"version": "4.3.0
|
|
3
|
+
"version": "4.3.0",
|
|
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": [
|