@whenessel/seql-js 1.1.0 → 1.1.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/README.md CHANGED
@@ -97,27 +97,35 @@ Resolution: EID → resolve() → ResolveResult
97
97
  ### SEQL Selector Functions
98
98
 
99
99
  #### `generateSEQL(element, generatorOptions?, stringifyOptions?)`
100
+
100
101
  Convenience function: `generateEID` + `stringifySEQL`. Returns a string or `null`.
101
102
 
102
103
  #### `resolveSEQL(selector, root, options?)`
104
+
103
105
  Convenience function: `parseSEQL` + `resolve`. Returns `Element[]`.
104
106
 
105
107
  #### `parseSEQL(selector)`
108
+
106
109
  Parses a SEQL Selector into an `ElementIdentity` object.
107
110
 
108
111
  #### `stringifySEQL(eid, options?)`
112
+
109
113
  Converts an `ElementIdentity` object into a canonical SEQL Selector.
110
114
 
111
115
  ### Core Functions
112
116
 
113
117
  #### `generateEID(element, options?)`
118
+
114
119
  Generates an `ElementIdentity` (EID) from a DOM element.
120
+
115
121
  - `maxPathDepth`: Default 10.
116
122
  - `enableSvgFingerprint`: Default true.
117
123
  - `confidenceThreshold`: Default 0.1.
118
124
 
119
125
  #### `resolve(eid, root, options?)`
126
+
120
127
  Resolves an EID back to DOM element(s). Returns a `ResolveResult` object.
128
+
121
129
  - `status`: `'success' | 'ambiguous' | 'error' | 'degraded-fallback'`.
122
130
  - `elements`: `Element[]` of matches.
123
131
  - `confidence`: Match confidence score (0-1).
@@ -125,9 +133,11 @@ Resolves an EID back to DOM element(s). Returns a `ResolveResult` object.
125
133
  ### Utilities & Advanced
126
134
 
127
135
  #### `generateEIDBatch(elements, options?)`
136
+
128
137
  Optimized generation for multiple elements at once.
129
138
 
130
139
  #### `createEIDCache(options?)` / `getGlobalCache()`
140
+
131
141
  Manage the LRU cache to improve performance for frequent generations/resolutions.
132
142
 
133
143
  ## Project Structure
@@ -148,14 +158,20 @@ Manage the LRU cache to improve performance for frequent generations/resolutions
148
158
 
149
159
  ## Documentation
150
160
 
151
- - [Architecture Design](docs/specs/ARCHITECTURE.md)
152
- - [EID Specification v1.0](docs/specs/SPECIFICATION.md) (Russian)
153
- - [Developer Guidelines](CLAUDE.md)
154
- - [Migration Guide](docs/MIGRATION.md)
161
+ - **[Getting Started](docs/getting-started/)** - Installation and quick start guide
162
+ - **[API Reference](docs/api/)** - Complete API documentation
163
+ - **[Examples](docs/examples/)** - Practical code examples
164
+ - **[Specification](docs/specification/)** - EID and SEQL format specifications
165
+ - **[Architecture](docs/architecture/)** - System design and internals
166
+ - **[Guides](docs/guides/)** - Advanced topics and patterns
167
+ - **[Contributing](docs/contributing/)** - Development guide
168
+ - **[Troubleshooting](docs/troubleshooting/)** - Common issues and solutions
169
+ - **[CLAUDE.md](CLAUDE.md)** - AI agent development guidelines
155
170
 
156
171
  ## Migrating from v0.x
157
172
 
158
173
  If you are upgrading from v0.x, note these breaking changes:
174
+
159
175
  - `generateDsl()` → `generateEID()`
160
176
  - `resolveDsl()` → `resolve()`
161
177
  - `DslIdentity` → `ElementIdentity`
package/dist/seql-js.d.ts CHANGED
@@ -1154,8 +1154,7 @@ export declare class SvgFingerprinter {
1154
1154
  /**
1155
1155
  * Target node - the element being identified
1156
1156
  */
1157
- export declare interface TargetNode extends PathNode {
1158
- }
1157
+ export declare type TargetNode = PathNode;
1159
1158
 
1160
1159
  /**
1161
1160
  * Text content with normalization