@veltdev/types-dev 4.5.6-beta.31 → 4.5.6-beta.5
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 +1 -4
- package/app/models/data/comment-annotation.data.model.d.ts +0 -1
- package/app/models/data/comment.data.model.d.ts +0 -2
- package/app/models/data/live-state-data.data.model.d.ts +0 -6
- package/app/models/data/resolver.data.model.d.ts +0 -1
- package/app/models/data/target-element.data.model.d.ts +0 -5
- package/app/models/data/target-text-range.data.model.d.ts +0 -5
- package/app/models/data/user.data.model.d.ts +0 -22
- package/app/models/element/comment-element.model.d.ts +0 -20
- package/app/models/element/live-state-sync-element.model.d.ts +1 -11
- package/models.d.ts +0 -1
- package/package.json +1 -1
- package/app/models/data/anchor-record.data.model.d.ts +0 -109
|
@@ -3,7 +3,7 @@ import { Observable } from "rxjs";
|
|
|
3
3
|
import { Config, DisableLogsConfig } from "../models/data/config.data.model";
|
|
4
4
|
import { DocumentUser } from "../models/data/document-user.data.model";
|
|
5
5
|
import { Location } from "../models/data/location.model";
|
|
6
|
-
import { User, UserOptions, VeltAuthProvider
|
|
6
|
+
import { User, UserOptions, VeltAuthProvider } from "../models/data/user.data.model";
|
|
7
7
|
import { CustomCss } from "../models/data/custom-css.data.model";
|
|
8
8
|
import { AreaElement } from "../models/element/area-element.model";
|
|
9
9
|
import { ArrowElement } from "../models/element/arrow-element.model";
|
|
@@ -100,9 +100,6 @@ export declare class Snippyly {
|
|
|
100
100
|
* To set the data provider.
|
|
101
101
|
*/
|
|
102
102
|
setDataProviders: (dataProvider: VeltDataProvider) => void;
|
|
103
|
-
|
|
104
|
-
setPermissionProvider: (permissionProvider: VeltPermissionProvider) => void;
|
|
105
|
-
|
|
106
103
|
/**
|
|
107
104
|
* To set the encryption provider.
|
|
108
105
|
*/
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Attachment } from "./attachment.model";
|
|
2
2
|
import { AutocompleteGroupReplaceData, AutocompleteReplaceData, AutocompleteUserContactReplaceData } from "./autocomplete.data.model";
|
|
3
|
-
import { ReactionAnnotation } from "./reaction-annotation.data.model";
|
|
4
3
|
import { RecordedData } from "./recorder.model";
|
|
5
4
|
import { User } from "./user.data.model";
|
|
6
5
|
export declare class Comment {
|
|
@@ -87,5 +86,4 @@ export declare class Comment {
|
|
|
87
86
|
*
|
|
88
87
|
*/
|
|
89
88
|
isEdited?: boolean;
|
|
90
|
-
reactionAnnotations?: ReactionAnnotation[];
|
|
91
89
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { AnchorRecord } from './anchor-record.data.model';
|
|
2
1
|
export declare class TargetElement {
|
|
3
2
|
/**
|
|
4
3
|
* Xpath of target element
|
|
@@ -20,8 +19,4 @@ export declare class TargetElement {
|
|
|
20
19
|
* Relative left position of cursor on target element
|
|
21
20
|
*/
|
|
22
21
|
leftPercentage: number;
|
|
23
|
-
/**
|
|
24
|
-
* Robust anchor descriptor for the element
|
|
25
|
-
*/
|
|
26
|
-
anchor?: AnchorRecord | null;
|
|
27
22
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { AnchorRecord } from "./anchor-record.data.model";
|
|
2
1
|
export declare class TargetTextRange {
|
|
3
2
|
/**
|
|
4
3
|
* Xpath of common Ancestor Container
|
|
@@ -12,10 +11,6 @@ export declare class TargetTextRange {
|
|
|
12
11
|
* Full xpath of common Ancestor Container with class names
|
|
13
12
|
*/
|
|
14
13
|
commonAncestorContainerCFXpath?: string;
|
|
15
|
-
/**
|
|
16
|
-
* Anchor of common Ancestor Container
|
|
17
|
-
*/
|
|
18
|
-
commonAncestorContainerAnchor?: AnchorRecord;
|
|
19
14
|
/**
|
|
20
15
|
* Selected text
|
|
21
16
|
*/
|
|
@@ -1,6 +1,4 @@
|
|
|
1
|
-
import { ResolverResponse } from "./resolver.data.model";
|
|
2
1
|
import { UserContact } from "./user-contact.data.model";
|
|
3
|
-
import { UserPermissionAccessRole } from "./user-resolver.data.model";
|
|
4
2
|
export declare class User {
|
|
5
3
|
/**
|
|
6
4
|
* Unique user identifier that you use to identify your user.
|
|
@@ -111,23 +109,3 @@ export interface VeltAuthProvider {
|
|
|
111
109
|
retryConfig?: AuthRetryConfig;
|
|
112
110
|
generateToken?: () => Promise<string>;
|
|
113
111
|
}
|
|
114
|
-
export interface VeltPermissionProvider {
|
|
115
|
-
onResourceAccessRequired: (requests: Array<PermissionQuery>) => Promise<ResolverResponse<PermissionResult[]>>;
|
|
116
|
-
retryConfig?: AuthRetryConfig;
|
|
117
|
-
forceRefresh?: boolean;
|
|
118
|
-
}
|
|
119
|
-
export interface PermissionQuery {
|
|
120
|
-
userId: string;
|
|
121
|
-
resource: {
|
|
122
|
-
id: string;
|
|
123
|
-
type: 'folder' | 'document' | 'organization';
|
|
124
|
-
};
|
|
125
|
-
}
|
|
126
|
-
export interface PermissionResult {
|
|
127
|
-
userId: string;
|
|
128
|
-
resourceId: string;
|
|
129
|
-
type: 'folder' | 'document' | 'organization';
|
|
130
|
-
accessRole?: UserPermissionAccessRole;
|
|
131
|
-
expiresAt?: number;
|
|
132
|
-
hasAccess: boolean;
|
|
133
|
-
}
|
|
@@ -1249,16 +1249,6 @@ export declare class CommentElement {
|
|
|
1249
1249
|
*/
|
|
1250
1250
|
public disableForceCloseAllOnEsc: () => void;
|
|
1251
1251
|
|
|
1252
|
-
/**
|
|
1253
|
-
* To mark comment annotation as read
|
|
1254
|
-
*/
|
|
1255
|
-
public markAsRead: (annotationId: string) => Promise<void>;
|
|
1256
|
-
|
|
1257
|
-
/**
|
|
1258
|
-
* To mark comment annotation as unread
|
|
1259
|
-
*/
|
|
1260
|
-
public markAsUnread: (annotationId: string) => Promise<void>;
|
|
1261
|
-
|
|
1262
1252
|
constructor();
|
|
1263
1253
|
/**
|
|
1264
1254
|
* Subscribe to comments on the current document.
|
|
@@ -2486,14 +2476,4 @@ export declare class CommentElement {
|
|
|
2486
2476
|
* To disable force close all on esc
|
|
2487
2477
|
*/
|
|
2488
2478
|
private _disableForceCloseAllOnEsc;
|
|
2489
|
-
|
|
2490
|
-
/**
|
|
2491
|
-
* To mark comment annotation as read
|
|
2492
|
-
*/
|
|
2493
|
-
private _markAsRead;
|
|
2494
|
-
|
|
2495
|
-
/**
|
|
2496
|
-
* To mark comment annotation as unread
|
|
2497
|
-
*/
|
|
2498
|
-
private _markAsUnread;
|
|
2499
2479
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
import { ServerConnectionState } from '../../utils/enums';
|
|
3
|
-
import { EditorAccessTimer,
|
|
3
|
+
import { EditorAccessTimer, LiveStateDataConfig, LiveStateSingleEditorExternalUserPresence, SetLiveStateDataConfig, SetUserAsEditorResponse, SingleEditorConfig, UserEditorAccess } from '../data/live-state-data.data.model';
|
|
4
4
|
import { LiveStateEventTypesMap } from '../data/live-state-events.data.model';
|
|
5
5
|
import { User } from '../data/user.data.model';
|
|
6
6
|
|
|
@@ -20,11 +20,6 @@ export declare class LiveStateSyncElement {
|
|
|
20
20
|
*/
|
|
21
21
|
getLiveStateData$: <T = unknown>(liveStateDataId?: string, liveStateDataConfig?: LiveStateDataConfig) => Observable<T>;
|
|
22
22
|
|
|
23
|
-
/**
|
|
24
|
-
* Fetches live state data.
|
|
25
|
-
*/
|
|
26
|
-
fetchLiveStateData: <T = unknown>(request?: FetchLiveStateDataRequest) => Promise<T>;
|
|
27
|
-
|
|
28
23
|
/**
|
|
29
24
|
* Sets live state data for the provided ID and data.
|
|
30
25
|
*/
|
|
@@ -183,11 +178,6 @@ export declare class LiveStateSyncElement {
|
|
|
183
178
|
*/
|
|
184
179
|
private _getLiveStateData$;
|
|
185
180
|
|
|
186
|
-
/**
|
|
187
|
-
* Private method for fetching live state data.
|
|
188
|
-
*/
|
|
189
|
-
private _fetchLiveStateData;
|
|
190
|
-
|
|
191
181
|
/**
|
|
192
182
|
* Private method for setting live state data.
|
|
193
183
|
*/
|
package/models.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
export * from './app/utils/enums';
|
|
2
|
-
export * from './app/models/data/anchor-record.data.model';
|
|
3
2
|
export * from './app/models/data/attachment.model';
|
|
4
3
|
export * from './app/models/data/area-annotation.data.model';
|
|
5
4
|
export * from './app/models/data/arrow-annotation.data.model';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/types-dev",
|
|
3
|
-
"version": "4.5.6-beta.
|
|
3
|
+
"version": "4.5.6-beta.5",
|
|
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": [
|
|
@@ -1,109 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Content hash for secure, privacy-preserving element validation.
|
|
3
|
-
*/
|
|
4
|
-
export interface ContentHash {
|
|
5
|
-
/** MD5 hash value (base36 encoded, ~12 characters) */
|
|
6
|
-
value: string;
|
|
7
|
-
/** Hashing algorithm (always 'md5') */
|
|
8
|
-
algorithm: 'md5';
|
|
9
|
-
/** Source of hash (always 'textContent') */
|
|
10
|
-
source: 'textContent';
|
|
11
|
-
}
|
|
12
|
-
/**
|
|
13
|
-
* Robust anchor record for reliable DOM element re-location.
|
|
14
|
-
*
|
|
15
|
-
* Survives:
|
|
16
|
-
* - Page reloads
|
|
17
|
-
* - Framework re-renders (React, Vue, Angular)
|
|
18
|
-
* - Dynamic ID changes
|
|
19
|
-
* - Minor DOM restructuring
|
|
20
|
-
*
|
|
21
|
-
* Does not survive:
|
|
22
|
-
* - Major redesigns
|
|
23
|
-
* - Content reordering (sort, filter)
|
|
24
|
-
* - Element removal
|
|
25
|
-
*
|
|
26
|
-
* **Resolution Strategy (priority order):**
|
|
27
|
-
* 1. id (90) - Stable, non-dynamic ID
|
|
28
|
-
* 2. css (80/60) - Attribute selector
|
|
29
|
-
* 3. robustXPath (50) - Attribute-based path
|
|
30
|
-
* 4. containerHints (40) - Scoped search
|
|
31
|
-
* 5. xPath variants (32-28) - Structural fallback
|
|
32
|
-
* 6. contentHash (15) - Hash-based scan
|
|
33
|
-
*
|
|
34
|
-
* **Validation boosts:** tagName (+10), contentHash (+30)
|
|
35
|
-
*
|
|
36
|
-
* **Security:** No plaintext storage, MD5 hash only.
|
|
37
|
-
*/
|
|
38
|
-
export interface AnchorRecord {
|
|
39
|
-
/** Schema version (current: "1.0") */
|
|
40
|
-
version: '1.0';
|
|
41
|
-
/**
|
|
42
|
-
* Stable element ID (non-dynamic only).
|
|
43
|
-
*
|
|
44
|
-
* Excluded patterns:
|
|
45
|
-
* - yui_* (YUI framework)
|
|
46
|
-
*/
|
|
47
|
-
id?: string;
|
|
48
|
-
/** Tag name (uppercase, e.g., 'DIV', 'BUTTON') */
|
|
49
|
-
tagName: string;
|
|
50
|
-
/**
|
|
51
|
-
* CSS selector from stable attributes.
|
|
52
|
-
*
|
|
53
|
-
* Example: `[data-testid='submit-btn'][role='button']`
|
|
54
|
-
*/
|
|
55
|
-
elementSelector?: string;
|
|
56
|
-
/**
|
|
57
|
-
* XPath variants (in order of stability):
|
|
58
|
-
*
|
|
59
|
-
* 1. robustXPath - Attribute-based (MOST STABLE)
|
|
60
|
-
* - Prioritizes: data-* > role > stable ID > aria-* > position
|
|
61
|
-
* - Example: `//div[@role='main']/.../li[5]/span`
|
|
62
|
-
* - Ignores dynamic IDs
|
|
63
|
-
* - Stops at landmarks (main, nav, etc.)
|
|
64
|
-
*
|
|
65
|
-
* 2. xPath - Basic XPath (uses IDs when available)
|
|
66
|
-
* 3. cfXPath - Positional with class hints
|
|
67
|
-
* 4. fXPath - Pure positional (most fragile)
|
|
68
|
-
*/
|
|
69
|
-
robustXPath?: string;
|
|
70
|
-
xPath?: string;
|
|
71
|
-
fXPath?: string;
|
|
72
|
-
cfXPath?: string;
|
|
73
|
-
/**
|
|
74
|
-
* Content hash for secure validation.
|
|
75
|
-
*/
|
|
76
|
-
contentHash?: ContentHash;
|
|
77
|
-
/** Creation timestamp (milliseconds since epoch) */
|
|
78
|
-
createdAt?: number;
|
|
79
|
-
/** Parent element anchor record */
|
|
80
|
-
parent?: AnchorRecord;
|
|
81
|
-
}
|
|
82
|
-
/**
|
|
83
|
-
* Result of anchor resolution.
|
|
84
|
-
*/
|
|
85
|
-
export interface AnchorResolution {
|
|
86
|
-
/** Resolved element (null if not found) */
|
|
87
|
-
element: Element | null;
|
|
88
|
-
/**
|
|
89
|
-
* Resolution method used.
|
|
90
|
-
* Values: 'id', 'css', 'robustXPath', 'xPath', 'cfXPath', 'fXPath', 'contentHash', 'ancestor+tag'
|
|
91
|
-
*/
|
|
92
|
-
matchedBy?: string;
|
|
93
|
-
/**
|
|
94
|
-
* Confidence score (0-120+).
|
|
95
|
-
*
|
|
96
|
-
* - 90+: High (unique ID)
|
|
97
|
-
* - 80-89: Good (unique CSS, stable attributes)
|
|
98
|
-
* - 40-79: Moderate (scoped search, multiple candidates)
|
|
99
|
-
* - 15-39: Low (XPath, hash-based fallback)
|
|
100
|
-
*/
|
|
101
|
-
score?: number;
|
|
102
|
-
/**
|
|
103
|
-
* Score breakdown.
|
|
104
|
-
*/
|
|
105
|
-
scoreBreakdown?: {
|
|
106
|
-
method: string;
|
|
107
|
-
score: number;
|
|
108
|
-
}[];
|
|
109
|
-
}
|