@veltdev/sdk 4.2.0-beta.1 → 4.2.0-beta.3
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/client/snippyly.model.d.ts +2 -2
- package/app/models/data/comment-resolver.data.model.d.ts +16 -15
- package/app/models/data/provider.data.model.d.ts +1 -1
- package/app/models/data/recorder-annotation.data.model.d.ts +29 -0
- package/app/models/element/recorder-element.model.d.ts +21 -1
- package/package.json +1 -1
- package/velt.js +2 -2
|
@@ -29,7 +29,7 @@ import { CoreEventTypesMap } from "../models/data/core-events.data.model";
|
|
|
29
29
|
import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest } from "../models/data/document.data.model";
|
|
30
30
|
import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
|
|
31
31
|
import { UserDataProvider } from "../models/data/user-resolver.data.model";
|
|
32
|
-
import {
|
|
32
|
+
import { VeltDataProvider } from "../models/data/provider.data.model";
|
|
33
33
|
|
|
34
34
|
export declare class Snippyly {
|
|
35
35
|
constructor();
|
|
@@ -82,7 +82,7 @@ export declare class Snippyly {
|
|
|
82
82
|
/**
|
|
83
83
|
* To set the data provider.
|
|
84
84
|
*/
|
|
85
|
-
setDataProviders: (dataProvider:
|
|
85
|
+
setDataProviders: (dataProvider: VeltDataProvider) => void;
|
|
86
86
|
/**
|
|
87
87
|
* Get Document ID
|
|
88
88
|
*/
|
|
@@ -1,41 +1,42 @@
|
|
|
1
1
|
import { BaseMetadata } from "./base-metadata.data.model";
|
|
2
2
|
import { CommentAnnotation } from "./comment-annotation.data.model";
|
|
3
3
|
export interface CommentAnnotationDataProvider {
|
|
4
|
-
get: (request:
|
|
5
|
-
save: (request:
|
|
6
|
-
delete: (
|
|
7
|
-
commentAnnotationId: string | number;
|
|
8
|
-
metadata?: BaseMetadata;
|
|
9
|
-
}) => Promise<void>;
|
|
4
|
+
get: (request: GetCommentRequest) => Promise<Record<string, PartialCommentAnnotation>>;
|
|
5
|
+
save: (request: SaveCommentRequest) => Promise<void>;
|
|
6
|
+
delete: (request: DeleteCommentRequest) => Promise<void>;
|
|
10
7
|
resolveTimeout?: number;
|
|
11
8
|
}
|
|
12
|
-
export interface
|
|
9
|
+
export interface GetCommentRequest {
|
|
13
10
|
organizationId: string;
|
|
14
11
|
commentAnnotationIds?: string[];
|
|
15
12
|
documentIds?: string[];
|
|
16
13
|
folderId?: string;
|
|
17
14
|
allDocuments?: boolean;
|
|
18
15
|
}
|
|
19
|
-
export interface
|
|
16
|
+
export interface DeleteCommentRequest {
|
|
17
|
+
commentAnnotationId: string;
|
|
18
|
+
metadata?: BaseMetadata;
|
|
19
|
+
}
|
|
20
|
+
export interface SaveCommentRequest {
|
|
20
21
|
commentAnnotation: {
|
|
21
|
-
[key: string]:
|
|
22
|
+
[key: string]: PartialCommentAnnotation;
|
|
22
23
|
};
|
|
23
24
|
}
|
|
24
|
-
export interface
|
|
25
|
+
export interface PartialComment {
|
|
25
26
|
commentId: string | number;
|
|
26
27
|
commentHtml?: string;
|
|
27
28
|
commentText?: string;
|
|
28
29
|
}
|
|
29
|
-
export interface
|
|
30
|
+
export interface PartialCommentAnnotationResult {
|
|
30
31
|
strippedData: {
|
|
31
|
-
[annotationId: string]:
|
|
32
|
+
[annotationId: string]: PartialCommentAnnotation;
|
|
32
33
|
} | null;
|
|
33
34
|
originalData: CommentAnnotation | null;
|
|
34
35
|
}
|
|
35
|
-
export interface
|
|
36
|
+
export interface PartialCommentAnnotation {
|
|
36
37
|
annotationId: string;
|
|
37
|
-
metadata?:
|
|
38
|
+
metadata?: BaseMetadata;
|
|
38
39
|
comments: {
|
|
39
|
-
[commentId: string]:
|
|
40
|
+
[commentId: string]: PartialComment;
|
|
40
41
|
};
|
|
41
42
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
|
|
2
2
|
import { UserDataProvider } from "./user-resolver.data.model";
|
|
3
|
-
export interface
|
|
3
|
+
export interface VeltDataProvider {
|
|
4
4
|
comment?: CommentAnnotationDataProvider;
|
|
5
5
|
user?: UserDataProvider;
|
|
6
6
|
}
|
|
@@ -131,6 +131,35 @@ export declare class RecorderAnnotation {
|
|
|
131
131
|
*/
|
|
132
132
|
displayName?: string;
|
|
133
133
|
metadata?: RecorderMetadata;
|
|
134
|
+
/**
|
|
135
|
+
* Current version of the recording edit
|
|
136
|
+
*/
|
|
137
|
+
latestVersion?: number;
|
|
138
|
+
/**
|
|
139
|
+
* History of all editing versions of this recording
|
|
140
|
+
* Maps version number to version data
|
|
141
|
+
*/
|
|
142
|
+
recordingEditVersions?: {
|
|
143
|
+
[key: number]: RecorderAnnotationEditVersion;
|
|
144
|
+
};
|
|
145
|
+
}
|
|
146
|
+
export interface RecorderAnnotationEditVersion {
|
|
147
|
+
from?: User;
|
|
148
|
+
createdAt?: Date;
|
|
149
|
+
attachment?: Attachment | null;
|
|
150
|
+
attachments?: Attachment[];
|
|
151
|
+
recordedTime?: {
|
|
152
|
+
duration?: number;
|
|
153
|
+
display?: string;
|
|
154
|
+
} | null;
|
|
155
|
+
transcription?: Transcription;
|
|
156
|
+
waveformData?: number[];
|
|
157
|
+
displayName?: string;
|
|
158
|
+
boundedTrimRanges?: RecorderBoundedTrimRange[];
|
|
159
|
+
}
|
|
160
|
+
export interface RecorderBoundedTrimRange {
|
|
161
|
+
start: number;
|
|
162
|
+
end: number;
|
|
134
163
|
}
|
|
135
164
|
export declare class RecorderMetadata extends BaseMetadata {
|
|
136
165
|
[key: string]: any;
|
|
@@ -45,6 +45,16 @@ export declare class RecorderElement {
|
|
|
45
45
|
*/
|
|
46
46
|
getRecordingData: (query: RecorderRequestQuery) => Promise<GetRecordingDataResponse>;
|
|
47
47
|
|
|
48
|
+
/**
|
|
49
|
+
* To enable video editor
|
|
50
|
+
*/
|
|
51
|
+
enableVideoEditor: () => void;
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* To disable video editor
|
|
55
|
+
*/
|
|
56
|
+
disableVideoEditor: () => void;
|
|
57
|
+
|
|
48
58
|
constructor();
|
|
49
59
|
|
|
50
60
|
private _initRecording;
|
|
@@ -86,4 +96,14 @@ export declare class RecorderElement {
|
|
|
86
96
|
* To get recording data by recorder ids
|
|
87
97
|
*/
|
|
88
98
|
private _getRecordingData;
|
|
89
|
-
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* To enable video editor
|
|
102
|
+
*/
|
|
103
|
+
private _enableVideoEditor;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* To disable video editor
|
|
107
|
+
*/
|
|
108
|
+
private _disableVideoEditor;
|
|
109
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/sdk",
|
|
3
|
-
"version": "4.2.0-beta.
|
|
3
|
+
"version": "4.2.0-beta.3",
|
|
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": [
|