@eyeglass/types 0.1.0 → 0.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 +24 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# @eyeglass/types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript definitions for the [Eyeglass](https://github.com/donutboyband/eyeglass) visual debugging tool.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @eyeglass/types
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { SemanticSnapshot, FocusPayload, InteractionStatus } from '@eyeglass/types';
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Types
|
|
18
|
+
|
|
19
|
+
- **`SemanticSnapshot`** - Complete context for a selected UI element (framework info, accessibility, geometry, styles)
|
|
20
|
+
- **`FocusPayload`** - Request payload sent from browser to bridge
|
|
21
|
+
- **`InteractionStatus`** - Status of an interaction (`idle` | `pending` | `fixing` | `success` | `failed`)
|
|
22
|
+
- **`ActivityEvent`** - Real-time events sent to the browser (status updates, thoughts, actions, questions)
|
|
23
|
+
|
|
24
|
+
See the [main repo](https://github.com/donutboyband/eyeglass) for full documentation.
|