@stuartshay/otel-data-types 1.0.34
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 +41 -0
- package/index.d.ts +1635 -0
- package/package.json +38 -0
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# @stuartshay/otel-data-types
|
|
2
|
+
|
|
3
|
+
TypeScript types auto-generated from the
|
|
4
|
+
[otel-data-api](https://github.com/stuartshay/otel-data-api) OpenAPI 3.1
|
|
5
|
+
specification.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @stuartshay/otel-data-types
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { paths, components } from '@stuartshay/otel-data-types';
|
|
17
|
+
|
|
18
|
+
// Typed API response
|
|
19
|
+
type LocationsResponse = paths['/api/v1/locations']['get']['responses']['200']['content']['application/json'];
|
|
20
|
+
|
|
21
|
+
// Typed schema
|
|
22
|
+
type Location = components['schemas']['Location'];
|
|
23
|
+
type GarminActivity = components['schemas']['GarminActivity'];
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Generation
|
|
27
|
+
|
|
28
|
+
Types are generated from the FastAPI source code using `openapi-typescript`:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
./scripts/generate-types.sh
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## API Coverage
|
|
35
|
+
|
|
36
|
+
- **Locations** — OwnTracks GPS data (CRUD, count, devices)
|
|
37
|
+
- **Garmin** — Activities and track points
|
|
38
|
+
- **Unified GPS** — Combined OwnTracks + Garmin view
|
|
39
|
+
- **Reference Locations** — Named locations with radius
|
|
40
|
+
- **Spatial** — PostGIS queries (nearby, distance, within-reference)
|
|
41
|
+
- **Health** — Liveness and readiness probes
|