@salus-js/nestjs v0.16.0

Intro

A library for mounting Salus operations at NestJS controllers. Retains full compatibility with the NestJS controller ecosystem.

Usage

The @salus-js/nestjs is a simple drop-in to any NestJS application. Let's look at handling a simple operation.

import { t } from '@salus-js/codec'
import { http } from '@salus-js/http'
import { Operation, Input, InputOf, OutputOf, SalusModule } from '@salus-js/nestjs'

const getUser = http.get('/v1/users/:id', {
  summary: 'Retrieve a user',
  description: 'Fetches the user associated with the given ID',
  params: t.object({
    id: t.string.document({
      description: 'Unique ID for the user to retrieve'
    })
  }),
  response: t.object({
    id: t.string.document({
      description: 'Unique ID for the user'
    }),
    name: t.string.document({
      description: 'Name for the user'
    })
  })
})

@Controller()
class UsersController {

  @Operation(getUser)
  public getUser(@Input() input: InputOf<typeof getUser>): OutputOf<typeof getUser> {
    return {
      id: input.params.id,
      name: 'Hello World'
    }
  }

}

@Module({
  imports: [
    SalusModule.forRoot()
  ],
  controllers: [
    UsersController
  ]
})
class AppModule {

}

Guide

Under the hood, there's very little magic happening with @salus-js/nestjs. The @Operation() module simply looks at the provided Operation instance and registers the appropriate NestJS controller annotation (@Post()/@Get()/etc) for you. Similarly, @Input() is implemented using standard NestJS functionality available through createParamDecorator.

What this means is that Salus retains full compatibility with all standard NestJS controllers. For many use cases, this provides the best balance of type safety with ergonomics in the NestJS ecosystem.

Registry

When using the Salus NestJS module, you get access to an instance of OperationRegistry that can provide you access to all operations that have been mounted in the NestJS. You can inject OperationRegistry from @salus-js/nestjs in any module.

OpenAPI

The NestJS module also supports automatically generating OpenAPI documents. You can enable this when importing the Salus module in your application:

@Module({
  imports: [
    SalusModule.forRoot({
      openApi: {
        path: '/openapi.yml',
        options: {
          info: {
            version: '1.0',
            title: 'My API
          }
        }
      }
    })
  ],
  controllers: [
    UsersController
  ]
})
class AppModule {

}