openapi-typescript-helpers

import type { paths } from './my-api'; // Assume this is generated by openapi-typescript import type { Readable, Writable } from 'openapi-typescript-helpers'; // Example: Define a schema type from openapi-typescript generated types type Pet = paths['/pets/{petId}']['get']['responses'][200]['content']['application/json']; // Create a type for a pet when fetching (should not include writeOnly fields) type ReadablePet = Readable<Pet>; // Create a type for creating a pet (should not include readOnly fields) type WritablePet = Writable<Pet>; interface PetInput { // Simulate a type with readOnly/writeOnly markers id: $Read<string>; name: string; tag?: string; secretToken: $Write<string>; } type FetchablePetInput = Readable<PetInput>; // id, name, tag type CreatablePetInput = Writable<PetInput>; // name, tag, secretToken // You would typically use these types in your API client logic: // async function fetchPet(petId: string): Promise<ReadablePet> { /* ... */ } // async function createPet(newPet: WritablePet): Promise<ReadablePet> { /* ... */ } // Demonstrate how the types change const petToCreate: CreatablePetInput = { name: 'Buddy', // id is excluded by Writable secretToken: process.env.PET_SECRET ?? '' // secretToken is included }; const fetchedPet: FetchablePetInput = { id: '123', name: 'Buddy' // secretToken is excluded by Readable };