@veltdev/types-dev 5.0.0-beta.1 → 5.0.0-beta.11
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/comment-events.data.model.d.ts +5 -0
- package/app/models/data/config.data.model.d.ts +8 -0
- package/app/models/element/comment-element.model.d.ts +34 -0
- package/app/models/element/crdt-element.model.d.ts +47 -0
- package/app/models/element/selection-element.model.d.ts +12 -0
- package/app/utils/enums.d.ts +1 -0
- package/package.json +1 -1
|
@@ -305,6 +305,11 @@ export declare class Snippyly {
|
|
|
305
305
|
*/
|
|
306
306
|
getUserPermissions: (request?: GetUserPermissionsRequest) => Promise<GetUserPermissionsResponse>;
|
|
307
307
|
|
|
308
|
+
/**
|
|
309
|
+
* To get current user permissions.
|
|
310
|
+
*/
|
|
311
|
+
getCurrentUserPermissions: () => Observable<GetUserPermissionsResponse | null>;
|
|
312
|
+
|
|
308
313
|
/**
|
|
309
314
|
* To check if plan is expired or not.
|
|
310
315
|
*/
|
|
@@ -79,6 +79,7 @@ export type CommentEventTypesMap = {
|
|
|
79
79
|
[CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
|
|
80
80
|
[CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
|
|
81
81
|
[CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
|
|
82
|
+
[CommentEventTypes.COMPOSER_TEXT_CHANGE]: ComposerTextChangeEvent;
|
|
82
83
|
[CommentEventTypes.LINK_CLICKED]: LinkClickedEvent;
|
|
83
84
|
[CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
|
|
84
85
|
[CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
|
|
@@ -275,3 +276,7 @@ export interface CommentBubbleClickedEvent {
|
|
|
275
276
|
commentAnnotation: CommentAnnotation;
|
|
276
277
|
metadata?: VeltEventMetadata;
|
|
277
278
|
}
|
|
279
|
+
export interface ComposerTextChangeEvent {
|
|
280
|
+
text: string;
|
|
281
|
+
metadata?: VeltEventMetadata;
|
|
282
|
+
}
|
|
@@ -53,6 +53,14 @@ export declare class Config {
|
|
|
53
53
|
* The domain of the API proxy.
|
|
54
54
|
*/
|
|
55
55
|
apiProxyDomain?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Controls whether global Velt styles are loaded.
|
|
58
|
+
* When true (default), global styles are applied.
|
|
59
|
+
* When false, global styles are not loaded - useful for custom styling.
|
|
60
|
+
*
|
|
61
|
+
* Default: true
|
|
62
|
+
*/
|
|
63
|
+
globalStyles?: boolean;
|
|
56
64
|
}
|
|
57
65
|
export interface ExtendedFirebaseOptions extends FirebaseOptions {
|
|
58
66
|
storeDbId: string;
|
|
@@ -1269,6 +1269,23 @@ export declare class CommentElement {
|
|
|
1269
1269
|
*/
|
|
1270
1270
|
public disableScreenshot: () => void;
|
|
1271
1271
|
|
|
1272
|
+
/**
|
|
1273
|
+
* To programmatically submit a comment from a velt-comment-composer.
|
|
1274
|
+
* Finds the composer within the element identified by referenceId and submits its content.
|
|
1275
|
+
* @param referenceId The ID of the HTML element containing the velt-comment-composer
|
|
1276
|
+
*/
|
|
1277
|
+
public submitComment: (referenceId: string) => void;
|
|
1278
|
+
|
|
1279
|
+
/**
|
|
1280
|
+
* To enable paginated contact list
|
|
1281
|
+
*/
|
|
1282
|
+
public enablePaginatedContactList: () => void;
|
|
1283
|
+
|
|
1284
|
+
/**
|
|
1285
|
+
* To disable paginated contact list
|
|
1286
|
+
*/
|
|
1287
|
+
public disablePaginatedContactList: () => void;
|
|
1288
|
+
|
|
1272
1289
|
constructor();
|
|
1273
1290
|
/**
|
|
1274
1291
|
* Subscribe to comments on the current document.
|
|
@@ -2516,4 +2533,21 @@ export declare class CommentElement {
|
|
|
2516
2533
|
* To disable screenshot
|
|
2517
2534
|
*/
|
|
2518
2535
|
private _disableScreenshot;
|
|
2536
|
+
|
|
2537
|
+
/**
|
|
2538
|
+
* To enable paginated contact list
|
|
2539
|
+
*/
|
|
2540
|
+
private _enablePaginatedContactList;
|
|
2541
|
+
|
|
2542
|
+
/**
|
|
2543
|
+
* To disable paginated contact list
|
|
2544
|
+
*/
|
|
2545
|
+
private _disablePaginatedContactList;
|
|
2546
|
+
|
|
2547
|
+
/**
|
|
2548
|
+
* To programmatically submit a comment from a velt-comment-composer.
|
|
2549
|
+
* Finds the composer within the element identified by referenceId and submits its content.
|
|
2550
|
+
* @param referenceId The ID of the HTML element containing the velt-comment-composer
|
|
2551
|
+
*/
|
|
2552
|
+
private _submitComment;
|
|
2519
2553
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
import { CrdtGetDataQuery, CrdtGetVersionQuery, CrdtOnDataChangeQuery, CrdtOnPresenceChangeQuery, CrdtOnRegisteredUserChangeQuery, CrdtOnStateChangeQuery, CrdtRegisterSyncUserQuery, CrdtSetPresenceQuery, CrdtSaveVersionQuery, CrdtUpdateDataQuery, CrdtUpdateStateQuery } from "../data/crdt.data.model";
|
|
3
|
+
import { CrdtEventTypesMap } from "../data/crdt-events.data.model";
|
|
3
4
|
|
|
4
5
|
export declare class CrdtElement {
|
|
5
6
|
/**
|
|
@@ -79,6 +80,29 @@ export declare class CrdtElement {
|
|
|
79
80
|
*/
|
|
80
81
|
getVersion: (getVersionQuery: CrdtGetVersionQuery) => Promise<any>;
|
|
81
82
|
|
|
83
|
+
/**
|
|
84
|
+
* Enable webhook
|
|
85
|
+
*/
|
|
86
|
+
enableWebhook: () => void;
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Disable webhook
|
|
90
|
+
*/
|
|
91
|
+
disableWebhook: () => void;
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* Set webhook debounce time
|
|
95
|
+
* @param time debounce time in milliseconds
|
|
96
|
+
*/
|
|
97
|
+
setWebhookDebounceTime: (time: number) => void;
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Subscribe to crdt actions
|
|
101
|
+
* @param action Action to subscribe to
|
|
102
|
+
* @returns Observable of the action
|
|
103
|
+
*/
|
|
104
|
+
on: <T extends keyof CrdtEventTypesMap>(action: T) => Observable<CrdtEventTypesMap[T]>;
|
|
105
|
+
|
|
82
106
|
constructor();
|
|
83
107
|
|
|
84
108
|
/**
|
|
@@ -163,4 +187,27 @@ export declare class CrdtElement {
|
|
|
163
187
|
* @param id Document ID
|
|
164
188
|
*/
|
|
165
189
|
private _getVersions;
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* Enable webhook
|
|
193
|
+
*/
|
|
194
|
+
private _enableWebhook;
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Disable webhook
|
|
198
|
+
*/
|
|
199
|
+
private _disableWebhook;
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Set webhook debounce time
|
|
203
|
+
* @param time debounce time in milliseconds
|
|
204
|
+
*/
|
|
205
|
+
private _setWebhookDebounceTime;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Subscribe to crdt actions
|
|
209
|
+
* @param action Action to subscribe to
|
|
210
|
+
* @returns Observable of the action
|
|
211
|
+
*/
|
|
212
|
+
private _on;
|
|
166
213
|
}
|
|
@@ -56,6 +56,12 @@ export declare class SelectionElement {
|
|
|
56
56
|
*/
|
|
57
57
|
getLiveSelectionData: () => Observable<LiveSelectionData | null>;
|
|
58
58
|
|
|
59
|
+
/**
|
|
60
|
+
* To set inactivity time (Default value is 5 minutes)
|
|
61
|
+
* @param time inactivity time in milliseconds
|
|
62
|
+
*/
|
|
63
|
+
setInactivityTime: (time: number) => void;
|
|
64
|
+
|
|
59
65
|
constructor();
|
|
60
66
|
|
|
61
67
|
/**
|
|
@@ -112,4 +118,10 @@ export declare class SelectionElement {
|
|
|
112
118
|
* To get live selection data
|
|
113
119
|
*/
|
|
114
120
|
private _getLiveSelectionData;
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* To set inactivity time (Default value is 5 minutes)
|
|
124
|
+
* @param time inactivity time in milliseconds
|
|
125
|
+
*/
|
|
126
|
+
private _setInactivityTime;
|
|
115
127
|
}
|
package/app/utils/enums.d.ts
CHANGED
|
@@ -56,6 +56,7 @@ export declare const CommentEventTypes: {
|
|
|
56
56
|
readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
|
|
57
57
|
readonly AUTOCOMPLETE_SEARCH: "autocompleteSearch";
|
|
58
58
|
readonly COMPOSER_CLICKED: "composerClicked";
|
|
59
|
+
readonly COMPOSER_TEXT_CHANGE: "composerTextChange";
|
|
59
60
|
readonly LINK_CLICKED: "linkClicked";
|
|
60
61
|
readonly COMMENT_PIN_CLICKED: "commentPinClicked";
|
|
61
62
|
readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/types-dev",
|
|
3
|
-
"version": "5.0.0-beta.
|
|
3
|
+
"version": "5.0.0-beta.11",
|
|
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": [
|