@veltdev/types 6.0.12 → 6.0.14-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/config.data.model.d.ts +18 -0
- package/app/models/data/user.data.model.d.ts +13 -0
- package/app/models/element/activity-element.model.d.ts +9 -0
- package/app/models/element/autocomplete-element.model.d.ts +10 -0
- package/app/models/element/comment-element.model.d.ts +72 -0
- package/app/models/element/notification-element.model.d.ts +17 -0
- package/app/utils/constants.d.ts +1 -0
- package/package.json +1 -1
|
@@ -175,6 +175,24 @@ export interface SelfHostedConfig {
|
|
|
175
175
|
* unchanged — no behavior change when the backend does not send it.
|
|
176
176
|
*/
|
|
177
177
|
enablePortableBackend?: boolean;
|
|
178
|
+
/**
|
|
179
|
+
* Tier B (portable backend) identify bootstrap: the base URL of the customer's OWN
|
|
180
|
+
* self-hosted gateway (e.g. `https://velt.customer.internal`). Identify is what
|
|
181
|
+
* RETURNS `wsEndpoint`/`apiEndpoint`, so the gateway's address cannot come from
|
|
182
|
+
* identify itself — this option tells the SDK where to send it.
|
|
183
|
+
*
|
|
184
|
+
* - Unset (default): identify goes to the Velt-hosted `validateClient` URL — behavior
|
|
185
|
+
* byte-identical to today, including when `enablePortableBackend` is true.
|
|
186
|
+
* - Set (requires `enablePortableBackend: true`): identify is a plain-JSON
|
|
187
|
+
* `POST {portableBackendUrl}/identify` on the customer's gateway (NOT a
|
|
188
|
+
* Firebase-callable envelope) and the SDK never contacts Velt infrastructure for
|
|
189
|
+
* identify. Set without the flag is a reported misconfiguration and is ignored.
|
|
190
|
+
*
|
|
191
|
+
* `https://` is required; plain `http://` is tolerated for loopback hosts only (local
|
|
192
|
+
* self-host development gateways) — an insecure URL fails closed with zero egress
|
|
193
|
+
* (never a silent fallback to Velt). See specs/self-hosting-tier2 iteration-8.
|
|
194
|
+
*/
|
|
195
|
+
portableBackendUrl?: string;
|
|
178
196
|
/**
|
|
179
197
|
* The RESOLVED module closure of the deployment profile (backend plan §8.3) — the
|
|
180
198
|
* enabled-module-id list the backend deploy tooling emits in
|
|
@@ -220,4 +220,17 @@ export interface PermissionResult {
|
|
|
220
220
|
accessRole?: UserPermissionAccessRole;
|
|
221
221
|
expiresAt?: number;
|
|
222
222
|
hasAccess: boolean;
|
|
223
|
+
/**
|
|
224
|
+
* ADDITIVE-OPTIONAL third state on Tier B gateway answers (backend Part 28
|
|
225
|
+
* iteration-1, `BACKEND-REPLY-THREE-ITEMS-2026-08-20.md` §2): on a
|
|
226
|
+
* folder-unprovisioned portable deployment, FOLDER-type entries answer
|
|
227
|
+
* `hasAccess: false` PLUS `errorCode: 'not_provided'` — "this deployment cannot
|
|
228
|
+
* answer the folder question", not "denied". Consumption contract (binding ack,
|
|
229
|
+
* `SDK-ACK-GETACCESS-ERRORCODE-2026-08-20.md`): the SDK skips the gate for the
|
|
230
|
+
* EXACT literal on FOLDER entries only; every other value — including unknown
|
|
231
|
+
* future codes — is inert and `hasAccess` is consumed verbatim. Entries for
|
|
232
|
+
* document/organization/context types never carry it; a provisioned build never
|
|
233
|
+
* emits `not_provided`. Hosted/resolver answers never carry this field.
|
|
234
|
+
*/
|
|
235
|
+
errorCode?: string;
|
|
223
236
|
}
|
|
@@ -29,4 +29,13 @@ export declare class ActivityElement {
|
|
|
29
29
|
* Create a new activity record.
|
|
30
30
|
*/
|
|
31
31
|
private _createActivity;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
35
|
+
* @returns Observable<any>
|
|
36
|
+
*/
|
|
37
|
+
public getActivityLogConfig: () => Observable<any>;
|
|
38
|
+
|
|
39
|
+
private _getActivityLogConfig;
|
|
40
|
+
|
|
32
41
|
}
|
|
@@ -21,4 +21,14 @@ export declare class AutocompleteElement {
|
|
|
21
21
|
* To get callback on autocomplete chip click
|
|
22
22
|
*/
|
|
23
23
|
private _onAutocompleteChipClick;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
27
|
+
* @param autocompleteId Autocomplete Id
|
|
28
|
+
* @returns Observable<any>
|
|
29
|
+
*/
|
|
30
|
+
public getAutocompleteConfig: (config: { autocompleteId: string }) => Observable<any>;
|
|
31
|
+
|
|
32
|
+
private _getAutocompleteConfig;
|
|
33
|
+
|
|
24
34
|
}
|
|
@@ -964,6 +964,68 @@ export declare class CommentElement {
|
|
|
964
964
|
*/
|
|
965
965
|
public getCommentAnnotationById: (config: { annotationId: string, documentId?: string }) => Observable<CommentAnnotation | null>;
|
|
966
966
|
|
|
967
|
+
/**
|
|
968
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
969
|
+
* @param annotationId Annotation Id
|
|
970
|
+
* @returns Observable<any>
|
|
971
|
+
*/
|
|
972
|
+
public getCommentDialogConfig: (config: { annotationId: string }) => Observable<any>;
|
|
973
|
+
|
|
974
|
+
/**
|
|
975
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
976
|
+
* @param contextId Context Id (defaults to 'default')
|
|
977
|
+
* @returns Observable<any>
|
|
978
|
+
*/
|
|
979
|
+
public getCommentBubbleConfig: (config: { contextId?: string }) => Observable<any>;
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
983
|
+
* @param contextId Context Id (defaults to 'default')
|
|
984
|
+
* @returns Observable<any>
|
|
985
|
+
*/
|
|
986
|
+
public getCommentPinConfig: (config: { contextId?: string }) => Observable<any>;
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
990
|
+
* @param contextId Context Id (defaults to 'default')
|
|
991
|
+
* @returns Observable<any>
|
|
992
|
+
*/
|
|
993
|
+
public getCommentsToolConfig: (config: { contextId?: string }) => Observable<any>;
|
|
994
|
+
|
|
995
|
+
/**
|
|
996
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
997
|
+
* @param contextId Context Id (defaults to 'default')
|
|
998
|
+
* @returns Observable<any>
|
|
999
|
+
*/
|
|
1000
|
+
public getMultiThreadDialogConfig: (config?: { contextId?: string }) => Observable<any>;
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
1004
|
+
* @param contextId Context Id (defaults to 'default')
|
|
1005
|
+
* @returns Observable<any>
|
|
1006
|
+
*/
|
|
1007
|
+
public getSidebarButtonConfig: (config: { contextId?: string }) => Observable<any>;
|
|
1008
|
+
|
|
1009
|
+
/**
|
|
1010
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
1011
|
+
* @param contextId Context Id (defaults to 'default')
|
|
1012
|
+
* @returns Observable<any>
|
|
1013
|
+
*/
|
|
1014
|
+
public getTextCommentConfig: (config: { contextId?: string }) => Observable<any>;
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
1018
|
+
* @param config Optional `{ targetElementId }` (defaults to the sole mounted section)
|
|
1019
|
+
* @returns Observable<any>
|
|
1020
|
+
*/
|
|
1021
|
+
public getInlineCommentsSectionConfig: (config?: { targetElementId?: string }) => Observable<any>;
|
|
1022
|
+
|
|
1023
|
+
/**
|
|
1024
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
1025
|
+
* @returns Observable<any>
|
|
1026
|
+
*/
|
|
1027
|
+
public getCommentSidebarConfig: () => Observable<any>;
|
|
1028
|
+
|
|
967
1029
|
/**
|
|
968
1030
|
* To enable collapsed comment
|
|
969
1031
|
*/
|
|
@@ -2383,6 +2445,15 @@ export declare class CommentElement {
|
|
|
2383
2445
|
* @returns Observable<CommentAnnotation | null>
|
|
2384
2446
|
*/
|
|
2385
2447
|
private _getCommentAnnotationById;
|
|
2448
|
+
private _getCommentDialogConfig;
|
|
2449
|
+
private _getCommentBubbleConfig;
|
|
2450
|
+
private _getCommentPinConfig;
|
|
2451
|
+
private _getCommentsToolConfig;
|
|
2452
|
+
private _getMultiThreadDialogConfig;
|
|
2453
|
+
private _getSidebarButtonConfig;
|
|
2454
|
+
private _getTextCommentConfig;
|
|
2455
|
+
private _getInlineCommentsSectionConfig;
|
|
2456
|
+
private _getCommentSidebarConfig;
|
|
2386
2457
|
|
|
2387
2458
|
/**
|
|
2388
2459
|
* To enable collapsed comment
|
|
@@ -2893,4 +2964,5 @@ export declare class CommentElement {
|
|
|
2893
2964
|
* To disable pin drag
|
|
2894
2965
|
*/
|
|
2895
2966
|
private _disablePinDrag;
|
|
2967
|
+
|
|
2896
2968
|
}
|
|
@@ -308,4 +308,21 @@ export declare class NotificationElement {
|
|
|
308
308
|
* Subscribe to notification events
|
|
309
309
|
*/
|
|
310
310
|
private _on;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
314
|
+
* @returns Observable<any>
|
|
315
|
+
*/
|
|
316
|
+
public getNotificationsPanelConfig: () => Observable<any>;
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* @experimental Read this feature's live derived config. Read-only; its shape is internal and may change between releases.
|
|
320
|
+
* @returns Observable<any>
|
|
321
|
+
*/
|
|
322
|
+
public getNotificationsToolConfig: () => Observable<any>;
|
|
323
|
+
|
|
324
|
+
private _getNotificationsPanelConfig;
|
|
325
|
+
|
|
326
|
+
private _getNotificationsToolConfig;
|
|
327
|
+
|
|
311
328
|
}
|
package/app/utils/constants.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/types",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.0.14-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": [
|