Types API

NestJS Data Transfer Object definitions for common backend types.

What It Does

The Types API provides NestJS-specific DTO (Data Transfer Object) implementations for common Foundation backend types, enabling Swagger/OpenAPI documentation and runtime validation at API boundaries.

Key Capabilities

NestJS DTOs: Class-based models with decorators for API documentation
Swagger Integration: @ApiProperty() decorators for automatic OpenAPI generation
Runtime Validation: class-validator decorators for input validation
Type Safety: Implements interfaces from @engineering11/types

Main Export

AlgoliaKeyPackageDTO


class AlgoliaKeyPackageDTO implements IAlgoliaKeyPackage {
  @ApiProperty()
  @IsString()
  searchAppId: string
 
  @ApiProperty()
  @IsString()
  searchKey: string
}

Used in search key endpoints for returning secured Algolia API keys.

Common Use Cases

REST API response types
Swagger documentation generation
Request/response validation
Type-safe API contracts

What Customers Don’t Have to Build

NestJS DTO classes
Swagger decorators
Validation rules
Type implementations