Copilot Instructions for ts-class-to-openapi

Project Context

This is the ts-class-to-openapi project - a powerful TypeScript library that transforms TypeScript classes into OpenAPI 3.1.0 schema objects.

🎯 Project Purpose

Transform TypeScript classes into OpenAPI-compatible schemas with support for:

Pure TypeScript classes (no decorators required)
class-validator decorated classes (enhanced validation)
Zero runtime dependencies (no reflect-metadata needed)

🚀 Key Features

✅ Pure TypeScript Support - Transform any TypeScript class without decorators
✅ class-validator Compatible - Enhanced schemas with validation decorators
✅ Enum Support - Full support for TypeScript enums and object enums with @IsEnum
✅ CommonJS & ESM Compatible - Works in any Node.js project
✅ Zero Runtime Dependencies - No
```
reflect-metadata
```
or
```
emitDecoratorMetadata
```
required
✅ OpenAPI 3.1.0 - Industry-standard schema generation
✅ TypeScript Native - Full type support and safety
✅ High Performance - Singleton pattern with built-in caching
✅ Nested Objects - Handles complex relationships automatically
✅ Typed Arrays - Full support for arrays with validation
✅ File Uploads - Binary file upload support

📁 Project Structure

src/
├── index.ts              # Main export file
├── transformer.ts        # Core transformation logic
├── types.ts             # Type definitions
└── __test__/            # Test files
examples/                # Usage examples

🎯 Main API

import { transform } from 'ts-class-to-openapi'

// Transform any TypeScript class
const schema = transform(MyClass)
// Returns: { name: string, schema: OpenAPISchema }

💡 Development Guidelines

When working on this project, always consider:

Zero Dependencies: The core library should have zero runtime dependencies
Pure TypeScript Support: Must work without decorators or reflect-metadata
class-validator Enhancement: Should enhance (not require) class-validator decorators
Performance: Use singleton pattern and caching for repeated transformations
Type Safety: Maintain full TypeScript support
OpenAPI 3.1.0 Compliance: Generated schemas must be valid OpenAPI 3.1.0

🔧 Technology Stack

TypeScript - Core language
TypeScript Compiler API - For type analysis (instead of reflect-metadata)
class-validator - Optional enhancement for validation decorators
OpenAPI 3.1.0 - Target schema format

Always keep this context in mind when providing suggestions, writing code, or debugging issues in this project.

Project Context

This is the ts-class-to-openapi project - a powerful TypeScript library that transforms TypeScript classes into OpenAPI 3.1.0 schema objects.

Transform TypeScript classes into OpenAPI-compatible schemas with support for:

Pure TypeScript classes (no decorators required)

class-validator decorated classes (enhanced validation)

Zero runtime dependencies (no reflect-metadata needed)

✅ Pure TypeScript Support - Transform any TypeScript class without decorators

✅ class-validator Compatible - Enhanced schemas with validation decorators

✅ Enum Support - Full support for TypeScript enums and object enums with @IsEnum

✅ CommonJS & ESM Compatible - Works in any Node.js project

✅ Zero Runtime Dependencies - No

reflect-metadata

emitDecoratorMetadata

required

✅ OpenAPI 3.1.0 - Industry-standard schema generation

✅ TypeScript Native - Full type support and safety

✅ High Performance - Singleton pattern with built-in caching

✅ Nested Objects - Handles complex relationships automatically

✅ Typed Arrays - Full support for arrays with validation

✅ File Uploads - Binary file upload support

src/
├── index.ts              # Main export file
├── transformer.ts        # Core transformation logic
├── types.ts             # Type definitions
└── __test__/            # Test files
examples/                # Usage examples

import { transform } from 'ts-class-to-openapi'

// Transform any TypeScript class
const schema = transform(MyClass)
// Returns: { name: string, schema: OpenAPISchema }

When working on this project, always consider:

Zero Dependencies: The core library should have zero runtime dependencies

Pure TypeScript Support: Must work without decorators or reflect-metadata

class-validator Enhancement: Should enhance (not require) class-validator decorators

Performance: Use singleton pattern and caching for repeated transformations

Type Safety: Maintain full TypeScript support

OpenAPI 3.1.0 Compliance: Generated schemas must be valid OpenAPI 3.1.0

TypeScript - Core language

TypeScript Compiler API - For type analysis (instead of reflect-metadata)

class-validator - Optional enhancement for validation decorators

OpenAPI 3.1.0 - Target schema format

Always keep this context in mind when providing suggestions, writing code, or debugging issues in this project.

Copilot Instructions for ts-class-to-openapi

Copilot Instructions for ts-class-to-openapi

Project Context

🎯 Project Purpose

🚀 Key Features

📁 Project Structure

🎯 Main API

💡 Development Guidelines

🔧 Technology Stack

Related Skills

Markdown Converter

Nano Banana Pro

1password

Copilot Instructions for ts-class-to-openapi

Project Context

🎯 Project Purpose

🚀 Key Features

📁 Project Structure

🎯 Main API

💡 Development Guidelines

🔧 Technology Stack