Setu-TS Framework Documentation

Welcome to the Setu-TS framework documentation. This documentation hub provides a complete guide to building production-ready applications with our plugin-first, runtime-independent framework.

Quick Start

• Getting Started: Learn how to set up your first Setu-TS application
  • Installation & Setup
  • First Application
  • Running on Different Runtimes

Core Concepts

• How It Fits Together

  • When plugins register and when a lookup misses
  • Service registry versus DI container
  • Which test helper replaces which service

• Plugin Architecture

  • Understanding the plugin contract
  • Capability tokens and service registration
  • Middleware pipeline
  • Lifecycle hooks

• Programmatic API

  • Application creation and configuration
  • Router and route definitions
  • Request/response handling
  • Service registry

• Decorators Guide

  • Optional decorator support
  • Controller and route decorators
  • Dependency injection
  • Custom decorators

• Authorization

  • Roles versus policies, and where attribute rules go
  • Route guards, @RequirePolicy, and checks inside a handler
  • The fixed evaluation rules

• Localization

  • Choosing how users pick a language
  • Catalogues and plural forms
  • Server views, React Router and browser clients
  • Caching localized responses

• Inbound webhooks

  • Raw-body signatures and replay windows
  • Tier-C de-duplication, outbox events and queue retries

Tooling

• CLI Guide
  • Scaffolding projects: templates, runtimes, and the functional/class-based choice
  • Generating code: the schematics and where each one is wired
  • Controllers and domain modules: one place for routes, and the first setu g module
  • Monorepo workspaces and service discovery

Plugin Reference

• Plugin Catalog

  • Complete list of all published plugins
  • Runtime compatibility matrix
  • Package links and API references

• Custom Plugin Development

  • Building your own plugins
  • Service registration patterns
  • Testing custom plugins

Version Upgrades

• Upgrading Setu-TS
  • Reader-side steps, version by version
  • Removing experimentalDecorators from your own manifest
  • Adding required IRepository members to hand-written implementors

Migration Guides

• Migrating from NestJS

  • Concept mapping
  • Code examples
  • Known differences

• Migrating from Fastify

  • Plugin patterns
  • Hook equivalents
  • Runtime model differences

Examples

• Runnable Examples
  • Minimal application
  • REST API
  • CQRS pattern
  • Multi-tenancy
  • Microservices
  • And more…

Deployment

• Runtime Deployment
• Deployment: Docker and Kubernetes
  • Node.js deployment
  • Deno deployment
  • Bun deployment
  • Cloudflare Workers deployment
  • Streaming and SSE
  • Runtime-specific resources
• Serverless: AWS Lambda and Azure Functions
  • Lambda Web Functions, classic Lambda and Azure Functions recipes
  • Queue and timer handlers over a booted application

API Reference

• Generated API Documentation
  • Full symbol-level reference
  • Generated from source with deno doc
  • Rebuild with pnpm run docs:api

Additional Resources

• Framework README

  • Project overview
  • Feature matrix
  • Quick links

• Architecture Guide

  • System design
  • Package structure
  • Design decisions

• Public API Reference

  • Authoritative public contract
  • Breaking change policy

• Changelog

  • Version history
  • Migration notes

Contributing

See the root README for contribution guidelines.