@growsober/types

Auto-generated TypeScript types from the GrowSober API OpenAPI specification.

Installation

npm install @growsober/types

Usage

import type { paths, components } from '@growsober/types';

// Access schema types
type User = components['schemas']['UserResponseDto'];
type Event = components['schemas']['EventResponseDto'];
type Hub = components['schemas']['HubResponseDto'];

// Access path types for type-safe API calls
type LoginRequest = paths['/api/v1/auth/login']['post']['requestBody']['content']['application/json'];
type LoginResponse = paths['/api/v1/auth/login']['post']['responses']['200']['content']['application/json'];

Generating Types

Types are auto-generated from the running API's OpenAPI spec:

# From local development API
npm run generate

# From production API
npm run generate:prod

Available Types

Auth Types

• RegisterDto - Registration request
• LoginDto - Login request
• AuthResponseDto - Auth response with tokens
• RefreshTokenDto - Token refresh request
• TokenResponseDto - Token response
• FirebaseAuthDto - Firebase auth request

User Types

• UserResponseDto - Full user profile
• UserPublicResponseDto - Public profile
• CreateUserDto - Create user request
• UpdateUserDto - Update user request

Hub Types

• HubResponseDto - Hub details
• CreateHubDto - Create hub request
• UpdateHubDto - Update hub request

Event Types

• EventResponseDto - Event details
• CreateEventDto - Create event request
• UpdateEventDto - Update event request

Booking Types

• BookingResponseDto - Booking details
• CreateBookingDto - Create booking request

Library Types

• LibraryContentResponseDto - Content list item
• LibraryContentDetailResponseDto - Full content
• LibraryProgressResponseDto - User progress

Business Types

• BusinessResponseDto - Business details
• OfferResponseDto - Offer details
• RedeemOfferDto - Redeem offer request

Subscription Types

• SubscriptionResponseDto - Subscription details
• CreateCheckoutDto - Checkout request

Notification Types

• NotificationResponseDto - Notification details

Type Helpers

For convenience, use with @growsober/sdk which provides type extraction utilities:

import type {
  RequestBody,
  ResponseBody,
  QueryParams,
  PathParams
} from '@growsober/sdk';

// Extract request body type
type CreateEventBody = RequestBody<'/api/v1/events', 'post'>;

// Extract response type
type EventResponse = ResponseBody<'/api/v1/events/{id}', 'get'>;

Development

# Type check
npm run type-check

# Build
npm run build

License

UNLICENSED - Proprietary