Ts.ED Framework Documentation

Ts.ED is a framework designed for building scalable server-side applications in a Node.js environment. It is built with TypeScript and supports multiple programming paradigms, including Object-Oriented Programming (OOP) using classes and decorators, as well as Functional programming.

Ts.ED provides an abstraction layer over common Node.js HTTP frameworks via its Platform API, while still allowing direct access to the underlying framework's APIs for maximum flexibility.

The @tsed/platform-mcp package allows any Ts.ED HTTP adapter (such as Express, Fastify, or Koa) to expose an MCP endpoint. It enables the registration of MCP tools, resources, and prompts using either decorators or functional helpers.

Key features include:

• PlatformMcpModule: Mounts a configurable /mcp endpoint on top of @tsed/platform-http.
• Functional helpers: defineTool, defineResource, and definePrompt for registering handlers via DI tokens.
• Decorators: @Tool, @Prompt, and @Resource for declarative registration within services or controllers.
• Shared utilities: Includes MCP_SERVER and transport helpers to integrate the MCP SDK v2 server packages into the Ts.ED dependency injection system.

Ts.ED Engines is a template engine consolidation library that allows you to support multiple engine libraries within a single application.

Key features include:

• Support for multiple engine libraries.
• Extensibility: You can register your own custom engines.
• Configurable settings.
• Framework agnostic: Works with both Express and Koa (and is explicitly compatible with Express).

Ts.ED supports several ways to register providers for Dependency Injection:

• Class-based (Decorators): Use @Injectable for basic class providers, @Service for semantic clarity, or @Interceptor for registering interceptors.
• Functional API (Decorator-less): Use injectable(), .factory(), .asyncFactory(), or .value() for manual or advanced registration.
• Constants & Values: Use @Constant()/constant() for constants and @Value()/refValue() for injecting specific values.
• Scopes: Providers can be registered with singleton, request, or custom scopes.

Ts.ED supports the following runtimes:

• Node.js
• Node.js + Babel
• Node.js + Webpack
• Node.js + SWC
• Bun.js

Ts.ED provides several key capabilities for building robust applications:

• Multi-platform Support: Build servers using Express.js, Koa.js, or Fastify.js on Node.js or Bun.js.
• Class-based & Decorators: Define application components such as Controllers, ConfigSources, Models, Providers (DI), Interceptors, and Pipes using decorators.
• CLI: Use the Ts.ED CLI to quickly scaffold preconfigured applications.
• Plugin System: Extend functionality with over 100 available plugins or create your own.
• AI-forward: Includes resources and templates (like AGENTS.md) to accelerate development with AI agents.
• Testing: Built-in support for testing tools to ensure code quality.

The @tsed/json-mapper package provides two primary functions to transform data between plain JavaScript objects and class models:

• deserialize: Maps a plain object to a model instance.
• serialize: Maps a model instance to a plain JavaScript object.

This package relies on TypeScript metadata and decorators from the @tsed/schema package to perform these transformations. Ts.ED uses this internally to convert incoming request parameters into class instances and to convert endpoint return values into plain objects for the consumer.

The @tsed/objection package provides the following capabilities:

• Single Connection Configuration: Configure one database connection using the @Configuration decorator.
• Automatic Initialization: Databases are initialized during the server's OnInit phase.
• Model Declaration: Declare models from classes using annotations. Note that @tsed/objection utilizes JsonSchema and its decorators to generate database tables.

If you prefer not to scaffold from scratch, you can clone existing starter projects for various stacks, including:

• Database Kits: Prisma, TypeORM, Mongoose
• Frontend Kits: React, Vue.js
• Integration Kits: Socket.io, Passport.js, AWS, Azure AD
• General: Basic Kit, Production-ready template