@veltdev/sdk-staging 4.0.0-beta.7 → 4.0.0-beta.73
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 +5 -0
- package/app/models/data/arrow-annotation.data.model.d.ts +51 -0
- package/app/models/data/config.data.model.d.ts +1 -0
- package/app/models/data/multi-thread.data.model.d.ts +61 -0
- package/app/models/data/notification.model.d.ts +16 -0
- package/app/models/data/recorder-annotation.data.model.d.ts +6 -0
- package/app/models/data/recorder-events.data.model.d.ts +16 -0
- package/app/models/data/user-resolver.data.model.d.ts +5 -0
- package/app/models/element/recorder-element.model.d.ts +22 -1
- package/app/utils/constants.d.ts +1 -0
- package/app/utils/enums.d.ts +4 -0
- package/models.d.ts +4 -0
- package/package.json +1 -1
- package/velt.js +2 -2
|
@@ -27,6 +27,7 @@ import { ReactionElement } from "../models/element/reaction-element.model";
|
|
|
27
27
|
import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
|
|
28
28
|
import { CoreEventTypesMap } from "../models/data/core-events.data.model";
|
|
29
29
|
import { Document, SetDocumentsRequestOptions } from "../models/data/document.data.model";
|
|
30
|
+
import { UserDataProvider } from "../models/data/user-resolver.data.model";
|
|
30
31
|
export declare class Snippyly {
|
|
31
32
|
constructor();
|
|
32
33
|
initConfig: (apiKey: string, config?: Config) => void;
|
|
@@ -57,6 +58,10 @@ export declare class Snippyly {
|
|
|
57
58
|
* To unset the document id
|
|
58
59
|
*/
|
|
59
60
|
unsetDocumentId: () => void;
|
|
61
|
+
/**
|
|
62
|
+
* To set the user data provider.
|
|
63
|
+
*/
|
|
64
|
+
setUserDataProvider: (userDataProvider: UserDataProvider) => void;
|
|
60
65
|
/**
|
|
61
66
|
* Get Document ID
|
|
62
67
|
*/
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { AnnotationProperty } from "./annotation-property.data.model";
|
|
2
|
+
import { CursorPosition } from "./cursor-position.data.model";
|
|
3
|
+
import { Location } from "./location.model";
|
|
4
|
+
import { PageInfo } from "./page-info.model";
|
|
5
|
+
import { TargetElement } from "./target-element.data.model";
|
|
6
|
+
import { User } from "./user.data.model";
|
|
7
|
+
export declare class ArrowAnnotation {
|
|
8
|
+
/**
|
|
9
|
+
* Unique identifier for the arrow pin annotation.
|
|
10
|
+
*
|
|
11
|
+
* Auto generated.
|
|
12
|
+
*/
|
|
13
|
+
annotationId: string;
|
|
14
|
+
/**
|
|
15
|
+
* The user who created this arrow pin annotation.
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
from: User;
|
|
19
|
+
/**
|
|
20
|
+
* Color used for the arrow pin annotation.
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
color?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Timestamp when the arrow annotation was last updated.
|
|
26
|
+
*
|
|
27
|
+
* Auto generated.
|
|
28
|
+
*/
|
|
29
|
+
lastUpdated?: any;
|
|
30
|
+
/**
|
|
31
|
+
* Target element of attached annotation.
|
|
32
|
+
*/
|
|
33
|
+
targetElement?: TargetElement | null;
|
|
34
|
+
position?: CursorPosition | null;
|
|
35
|
+
/**
|
|
36
|
+
* Unique location id generated from provided location
|
|
37
|
+
*/
|
|
38
|
+
locationId?: number | null;
|
|
39
|
+
/**
|
|
40
|
+
* Set location to identify user on sub document
|
|
41
|
+
*/
|
|
42
|
+
location?: Location | null;
|
|
43
|
+
type?: string;
|
|
44
|
+
props: AnnotationProperty;
|
|
45
|
+
/**
|
|
46
|
+
* To maintain index of current annotation in available list of annotations
|
|
47
|
+
* It will start from 1, so no need to add 1 in that.
|
|
48
|
+
*/
|
|
49
|
+
annotationIndex?: number;
|
|
50
|
+
pageInfo?: PageInfo;
|
|
51
|
+
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { BaseMetadata } from "./base-metadata.data.model";
|
|
2
|
+
import { CommentAnnotation, GhostComment, InlineCommentSectionConfig } from "./comment-annotation.data.model";
|
|
3
|
+
import { CursorPosition } from "./cursor-position.data.model";
|
|
4
|
+
import { Location } from "./location.model";
|
|
5
|
+
import { TargetElement } from "./target-element.data.model";
|
|
6
|
+
import { TargetTextRange } from "./target-text-range.data.model";
|
|
7
|
+
import { User } from "./user.data.model";
|
|
8
|
+
export declare class MultiThreadCommentAnnotation {
|
|
9
|
+
/**
|
|
10
|
+
* The id of the annotation.
|
|
11
|
+
*/
|
|
12
|
+
annotationId: string;
|
|
13
|
+
/**
|
|
14
|
+
* The id of the area annotation.
|
|
15
|
+
*/
|
|
16
|
+
areaAnnotationId?: string;
|
|
17
|
+
/**
|
|
18
|
+
* The target element of the annotation.
|
|
19
|
+
*/
|
|
20
|
+
targetElement?: TargetElement | null;
|
|
21
|
+
/**
|
|
22
|
+
* The id of the target element.
|
|
23
|
+
*/
|
|
24
|
+
targetElementId?: string | null;
|
|
25
|
+
/**
|
|
26
|
+
* Selected text range of comment annotation
|
|
27
|
+
*/
|
|
28
|
+
targetTextRange?: TargetTextRange | null;
|
|
29
|
+
/**
|
|
30
|
+
* The id of the target inline comment element.
|
|
31
|
+
*/
|
|
32
|
+
targetInlineCommentElementId?: string;
|
|
33
|
+
/**
|
|
34
|
+
* The inline comment section config.
|
|
35
|
+
*/
|
|
36
|
+
inlineCommentSectionConfig?: InlineCommentSectionConfig;
|
|
37
|
+
commentAnnotations?: {
|
|
38
|
+
[commentAnnotationId: string]: boolean;
|
|
39
|
+
};
|
|
40
|
+
commentAnnotationsMap?: {
|
|
41
|
+
[commentAnnotationId: string]: CommentAnnotation;
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Unique location id generated from provided location
|
|
45
|
+
*/
|
|
46
|
+
locationId?: number | null;
|
|
47
|
+
/**
|
|
48
|
+
* Set location to identify user on sub document
|
|
49
|
+
*/
|
|
50
|
+
location?: Location | null;
|
|
51
|
+
position?: CursorPosition | null;
|
|
52
|
+
ghostComment?: GhostComment | null;
|
|
53
|
+
from: User;
|
|
54
|
+
type: string;
|
|
55
|
+
isDraft?: boolean;
|
|
56
|
+
sourceId?: string;
|
|
57
|
+
metadata?: MultiThreadMetadata;
|
|
58
|
+
}
|
|
59
|
+
export declare class MultiThreadMetadata extends BaseMetadata {
|
|
60
|
+
[key: string]: any;
|
|
61
|
+
}
|
|
@@ -88,6 +88,11 @@ export declare class NotificationRawData {
|
|
|
88
88
|
[key: string]: any;
|
|
89
89
|
};
|
|
90
90
|
displayBodyMessage?: string;
|
|
91
|
+
displayBodyMessageTemplate?: string;
|
|
92
|
+
displayBodyMessageTemplateData?: {
|
|
93
|
+
users?: User[];
|
|
94
|
+
[key: string]: any;
|
|
95
|
+
};
|
|
91
96
|
customData?: any;
|
|
92
97
|
notifyUsers?: {
|
|
93
98
|
[email: string]: boolean;
|
|
@@ -127,6 +132,17 @@ export declare class Notification {
|
|
|
127
132
|
* Notification body message
|
|
128
133
|
*/
|
|
129
134
|
displayBodyMessage?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Display body message template
|
|
137
|
+
*/
|
|
138
|
+
displayBodyMessageTemplate?: string;
|
|
139
|
+
/**
|
|
140
|
+
* Display body message template data
|
|
141
|
+
*/
|
|
142
|
+
displayBodyMessageTemplateData?: {
|
|
143
|
+
users?: User[];
|
|
144
|
+
[key: string]: any;
|
|
145
|
+
};
|
|
130
146
|
/**
|
|
131
147
|
* Display message template
|
|
132
148
|
*/
|
|
@@ -164,4 +164,10 @@ export declare class RecorderData {
|
|
|
164
164
|
assets: RecorderDataAsset[];
|
|
165
165
|
transcription: RecorderDataTranscription;
|
|
166
166
|
}
|
|
167
|
+
export interface RecorderRequestQuery {
|
|
168
|
+
recorderIds: string[];
|
|
169
|
+
}
|
|
170
|
+
export interface GetRecordingDataResponse {
|
|
171
|
+
data: Record<string, RecorderData> | null;
|
|
172
|
+
}
|
|
167
173
|
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { RecorderEventTypes } from "../../utils/enums";
|
|
2
|
+
export interface TranscriptionDoneEvent {
|
|
3
|
+
transcription: string;
|
|
4
|
+
id?: string;
|
|
5
|
+
tag?: string;
|
|
6
|
+
type?: string;
|
|
7
|
+
thumbnailUrl?: string;
|
|
8
|
+
thumbnailWithPlayIconUrl?: string;
|
|
9
|
+
videoUrl?: string;
|
|
10
|
+
audioUrl?: string;
|
|
11
|
+
videoPlayerUrl?: string;
|
|
12
|
+
getThumbnailTag?: (url?: string) => string;
|
|
13
|
+
}
|
|
14
|
+
export type RecorderEventTypesMap = {
|
|
15
|
+
[RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
|
|
16
|
+
};
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
import { Observable } from "rxjs";
|
|
3
|
-
import { RecorderData } from "../data/recorder-annotation.data.model";
|
|
3
|
+
import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse } from "../data/recorder-annotation.data.model";
|
|
4
|
+
import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
|
|
4
5
|
|
|
5
6
|
export declare class RecorderElement {
|
|
6
7
|
|
|
@@ -33,6 +34,16 @@ export declare class RecorderElement {
|
|
|
33
34
|
*/
|
|
34
35
|
disableRecordingTranscription: () => void;
|
|
35
36
|
|
|
37
|
+
/**
|
|
38
|
+
* Subscribe to recorder actions
|
|
39
|
+
*/
|
|
40
|
+
public on: <T extends keyof RecorderEventTypesMap>(action: T) => Observable<RecorderEventTypesMap[T]>;
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* To get recording data by recorder ids
|
|
44
|
+
*/
|
|
45
|
+
getRecordingData: (query: RecorderRequestQuery) => Promise<GetRecordingDataResponse>;
|
|
46
|
+
|
|
36
47
|
constructor();
|
|
37
48
|
|
|
38
49
|
private _initRecording;
|
|
@@ -63,4 +74,14 @@ export declare class RecorderElement {
|
|
|
63
74
|
* To disable recording transcription
|
|
64
75
|
*/
|
|
65
76
|
private _disableRecordingTranscription;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Subscribe to recorder actions
|
|
80
|
+
*/
|
|
81
|
+
private _on;
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* To get recording data by recorder ids
|
|
85
|
+
*/
|
|
86
|
+
private _getRecordingData;
|
|
66
87
|
}
|
package/app/utils/constants.d.ts
CHANGED
|
@@ -242,6 +242,7 @@ export declare class Constants {
|
|
|
242
242
|
VELT_COMMENT_DIALOG_BODY_THREAD_CARD: string;
|
|
243
243
|
VELT_COMMENT_DIALOG_PRIVATE_BANNER: string;
|
|
244
244
|
VELT_COMMENT_COMPOSER: string;
|
|
245
|
+
VELT_SKELETON_LOADER: string;
|
|
245
246
|
VELT_SHADOW_DOM_INTERNAL: string;
|
|
246
247
|
};
|
|
247
248
|
static ATTRIBUTES: {
|
package/app/utils/enums.d.ts
CHANGED
|
@@ -42,10 +42,14 @@ export declare const CommentEventTypes: {
|
|
|
42
42
|
readonly COMMENT_SIDEBAR_DATA_INIT: "commentSidebarDataInit";
|
|
43
43
|
readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
|
|
44
44
|
};
|
|
45
|
+
export declare const RecorderEventTypes: {
|
|
46
|
+
readonly TRANSCRIPTION_DONE: "transcriptionDone";
|
|
47
|
+
};
|
|
45
48
|
export declare const CoreEventTypes: {
|
|
46
49
|
readonly VELT_BUTTON_CLICK: "veltButtonClick";
|
|
47
50
|
};
|
|
48
51
|
export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
|
|
52
|
+
export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
|
|
49
53
|
export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
|
|
50
54
|
export declare enum TagStatus {
|
|
51
55
|
ADDED = "added",
|
package/models.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from './app/utils/enums';
|
|
2
2
|
export * from './app/models/data/attachment.model';
|
|
3
3
|
export * from './app/models/data/area-annotation.data.model';
|
|
4
|
+
export * from './app/models/data/arrow-annotation.data.model';
|
|
4
5
|
export * from './app/models/data/base-metadata.data.model';
|
|
5
6
|
export * from './app/models/data/button.data.model';
|
|
6
7
|
export * from './app/models/data/chatgpt.data.model';
|
|
@@ -28,12 +29,14 @@ export * from './app/models/data/localstorage.data.model';
|
|
|
28
29
|
export * from './app/models/data/location-metadata.model';
|
|
29
30
|
export * from './app/models/data/location.model';
|
|
30
31
|
export * from './app/models/data/media-preview-config.data.model';
|
|
32
|
+
export * from './app/models/data/multi-thread.data.model';
|
|
31
33
|
export * from './app/models/data/notification.model';
|
|
32
34
|
export * from './app/models/data/page-info.model';
|
|
33
35
|
export * from './app/models/data/permission.data.model';
|
|
34
36
|
export * from './app/models/data/presence-user.data.model';
|
|
35
37
|
export * from './app/models/data/recorder.model';
|
|
36
38
|
export * from './app/models/data/recorder-annotation.data.model';
|
|
39
|
+
export * from './app/models/data/recorder-events.data.model';
|
|
37
40
|
export * from './app/models/data/rewriter-annotation.data.model';
|
|
38
41
|
export * from './app/models/data/screen-size.data.model';
|
|
39
42
|
export * from './app/models/data/selection.model';
|
|
@@ -62,3 +65,4 @@ export * from './app/models/data/organization-groups.data.model';
|
|
|
62
65
|
export * from './app/models/data/organization-metadata.model';
|
|
63
66
|
export * from './app/models/data/user-organization.data.model';
|
|
64
67
|
export * from './app/models/data/event-metadata.data.model';
|
|
68
|
+
export * from './app/models/data/user-resolver.data.model';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/sdk-staging",
|
|
3
|
-
"version": "4.0.0-beta.
|
|
3
|
+
"version": "4.0.0-beta.73",
|
|
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": [
|