@truepic/vision-api-types 3.78.0 → 3.82.0
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 +10 -44
- package/index.d.ts +1255 -259
- package/package.json +3 -10
- package/LICENSE +0 -20
package/README.md
CHANGED
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
TypeScript type declarations for Truepic Vision API v3.
|
|
4
4
|
|
|
5
|
-
<a href="https://www.npmjs.com/package/@truepic/vision-api-types">
|
|
6
|
-
<img src="https://img.shields.io/npm/v/@truepic/vision-api-types?color=196dff" alt="npm">
|
|
7
|
-
</a>
|
|
8
|
-
|
|
9
5
|
## Installation
|
|
10
6
|
|
|
11
7
|
```bash
|
|
@@ -14,59 +10,29 @@ npm install @truepic/vision-api-types
|
|
|
14
10
|
|
|
15
11
|
## Usage
|
|
16
12
|
|
|
17
|
-
```
|
|
13
|
+
```ts
|
|
18
14
|
import type { components, paths } from '@truepic/vision-api-types'
|
|
19
15
|
|
|
20
16
|
type VisionInspectionSchema = components['schemas']['Inspection']
|
|
21
17
|
type VisionGetInspectionsPath = paths['/inspections']['get']
|
|
22
18
|
```
|
|
23
19
|
|
|
24
|
-
[OpenAPI TypeScript](https://openapi-ts.dev/) is used to generate the
|
|
25
|
-
|
|
20
|
+
[OpenAPI TypeScript](https://openapi-ts.dev/) is used to generate the types from
|
|
21
|
+
the
|
|
26
22
|
[Vision API OpenAPI specification](https://vision-api.truepic.com/v3/open-api).
|
|
27
|
-
See their [docs](https://openapi-ts.dev/introduction) for further details.
|
|
28
|
-
|
|
29
|
-
## Development
|
|
30
|
-
|
|
31
|
-
### Prerequisites
|
|
32
23
|
|
|
33
|
-
|
|
34
|
-
[`package.json`](package.json)).
|
|
24
|
+
## Publishing
|
|
35
25
|
|
|
36
|
-
|
|
26
|
+
This package is published automatically by the `vision-api` production
|
|
27
|
+
deployment workflow. Its version is kept in lockstep with `vision-api`.
|
|
37
28
|
|
|
38
|
-
|
|
29
|
+
To regenerate `index.d.ts` locally:
|
|
39
30
|
|
|
40
31
|
```bash
|
|
32
|
+
# from the repo root
|
|
33
|
+
npm run build # builds dist/Vision-API-V3.json
|
|
34
|
+
cd types
|
|
41
35
|
npm install
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Generate
|
|
45
|
-
|
|
46
|
-
To generate the TypeScript types from the OpenAPI specification to `index.d.ts`:
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
36
|
npm run generate
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Validate
|
|
53
|
-
|
|
54
|
-
To validate the generated TypeScript types in `index.d.ts`:
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
37
|
npm run validate
|
|
58
38
|
```
|
|
59
|
-
|
|
60
|
-
## Releasing
|
|
61
|
-
|
|
62
|
-
The TypeScript types must be manually generated, validated, and released after a
|
|
63
|
-
Vision API release. That process does not happen automatically at this time.
|
|
64
|
-
|
|
65
|
-
[Release It!](https://github.com/release-it/release-it) is used to orchestrate
|
|
66
|
-
the release process:
|
|
67
|
-
|
|
68
|
-
```bash
|
|
69
|
-
npm run release
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
The release version should match the Vision API version.
|