@truepic/vision-api-types 3.74.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 Truepic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# Truepic Vision API Types
+
+TypeScript type declarations for Truepic Vision API v3.
+
+![npm version](https://img.shields.io/npm/v/@truepic/vision-api-types?color=196dff)
+
+## Installation
+
+```bash
+npm install @truepic/vision-api-types
+```
+
+## Usage
+
+```js
+import type { components, paths } from '@truepic/vision-api-types'
+
+type VisionInspectionSchema = components['schemas']['Inspection']
+type VisionGetInspectionsPath = paths['/inspections']['get']
+```
+
+[OpenAPI TypeScript](https://openapi-ts.dev/) is used to generate the TypeScript
+types from the
+[Vision API OpenAPI specification](https://vision-api.truepic.com/v3/open-api).
+See their [docs](https://openapi-ts.dev/introduction) for further details.
+
+## Development
+
+### Prerequisites
+
+The only prerequisite is a compatible version of Node.js (see `engines.node` in
+[`package.json`](package.json)).
+
+### Dependencies
+
+Install dependencies with npm:
+
+```bash
+npm install
+```
+
+### Generate
+
+To generate the TypeScript types from the OpenAPI specification to `index.d.ts`:
+
+```bash
+npm run generate
+```
+
+### Validate
+
+To validate the generated TypeScript types in `index.d.ts`:
+
+```bash
+npm run validate
+```
+
+## Releasing
+
+The TypeScript types must be manually generated, validated, and released after a
+Vision API release. That process does not happen automatically at this time.
+
+[Release It!](https://github.com/release-it/release-it) is used to orchestrate
+the release process:
+
+```bash
+npm run release
+```
+
+The release version should match the Vision API version.