Nest.js

Nest runs on Express by default, so Corsair reuses the Express adapter, with no dedicated Nest adapter. Mount it as middleware in main.ts, before Nest’s router, and Corsair claims one base path. Everything else follows Nest’s grain. Register the corsair instance as a provider and inject it wherever you read integration data.

Install

The Express adapter ships in core corsair. Add a plugin package per service you integrate:

npm i corsair @corsair-dev/github

pnpm add corsair @corsair-dev/github

yarn add corsair @corsair-dev/github

bun add corsair @corsair-dev/github

Create the instance

Build the instance once. The handler and your read/write code both import it.

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { github } from '@corsair-dev/github';

export const corsair = createCorsair({
    database: new Database('corsair.db'),
    kek: process.env.CORSAIR_KEK!,
    multiTenancy: true,
    plugins: [github({ authType: 'managed' })], // one entry per @corsair-dev/* package you install
});

The handler and every .db / .api call on this page import this corsair. multiTenancy: true is what makes corsair.withTenant(id) available, and a tenant.github.* call resolves to the github() entry here. Add a service by installing its @corsair-dev/* package and dropping it into plugins. Database choices and the Hub keys are in Quick Start.

Mount the handler

The adapter reads the raw stream itself, so no express.json() and no body-parser wiring. Mount one line during bootstrap.

main.ts

import { NestFactory } from '@nestjs/core';
import type { NestExpressApplication } from '@nestjs/platform-express';
import { toExpressHandler } from 'corsair';
import { AppModule } from './app.module';
import { corsair } from './corsair';

async function bootstrap() {
    const app = await NestFactory.create<NestExpressApplication>(AppModule);
    app.use('/api/corsair', toExpressHandler(corsair, { basePath: '/api/corsair' }));
    await app.listen(3000);
}
bootstrap();

./corsair is your createCorsair({ ... }) instance. See Getting Started if you haven’t built it yet.

Resolve the tenant

Corsair only needs the tenant id, and your own auth produces it. A Guard populates request.user the way it already does in your app; read it off the request and pass the id to withTenant().

// a guard sets request.user; read it in the controller
const tenant = this.corsair.withTenant(await getTenantId(req));

getTenantId(req) is your own code that reads the signed-in user from your auth; it can return any stable id.

Read and write

The handler serves Hub delivery; your business logic reads and writes through the same instance. Provide it once, then inject it, and the corsair instance becomes a first-class Nest dependency.

corsair.module.ts

import { Global, Module } from '@nestjs/common';
import { corsair } from './corsair';

export const CORSAIR = Symbol('CORSAIR');

@Global()
@Module({
    providers: [{ provide: CORSAIR, useValue: corsair }],
    exports: [CORSAIR],
})
export class CorsairModule {}

issues.controller.ts

import { Body, Controller, Get, Inject, Post, Req } from '@nestjs/common';
import type { Request } from 'express';
import { CORSAIR } from './corsair.module';
import type { corsair } from './corsair';

@Controller('issues')
export class IssuesController {
    constructor(@Inject(CORSAIR) private readonly corsair: typeof corsair) {}

    @Get()
    async list(@Req() req: Request) {
        const tenant = this.corsair.withTenant(await getTenantId(req));
        // .db reads your own rows — no network, no rate limit
        const issues = await tenant.github.db.issues.search({ data: { state: 'open' }, limit: 50 });
        return issues.map((i) => i.data.title);
    }

    @Post()
    create(@Req() req: Request, @Body('title') title: string) {
        const tenant = this.corsair.withTenant(await getTenantId(req));
        // .api hits GitHub live; the response is upserted into your db
        return tenant.github.api.issues.create({ owner: 'acme', repo: 'app', title });
    }
}

Entity fields live on .data in camelCase. Reads come from .db; creates and updates go through .api and land back in the same rows. See Dashboards for the full pattern.

Connect a tenant

Nest is a backend, so use the vanilla client from your frontend, a worker, or a script to check connection status and mint connect links against the route above.

Create the client

corsair-client.ts

import { createCorsairClient } from "corsair";

export const client = createCorsairClient({ baseURL: "/api/corsair" });

createCorsairClient is a typed fetch wrapper over the management API, no React required. Use it from your frontend, a worker, or a script. Every route is typed against its response. Full surface on the Vanilla Client reference.

Read what's connected

connections.ts

const status = await client.connectionStatus.get({ tenantId: "acme" });
// { github: 'connected', slack: 'not_connected', notion: 'missing_credentials' }

connectionStatus.get returns a map of plugin id to connected | missing_credentials | not_connected, so you can show what’s live and what still needs connecting.

Mint a connect link

connect.ts

const { connectUrl } = await client.connect.createLink({
    plugin: "github",
    tenantId: "acme",
});
window.location.href = connectUrl; // send the user to Hub's hosted connect page

Hub hosts the consent screen and runs the OAuth handshake. When the user returns, the tokens are already encrypted in your own database. You never saw them, and neither did Hub. Swap "github" for any plugin you configured.

Go green

Start the app:

npm run start:dev

The first request to /api/corsair registers your delivery URL with Hub and turns the App sync dot in the dashboard header green.

Deploy

Deploy the Nest app however you already run it. In production the same /api/corsair route becomes the delivery URL Hub calls, so ensure it’s publicly reachable. The first request re-registers the production URL.

Vanilla client

Every management-API method the client exposes, fully typed.

Build a dashboard

The .db read / .api write pattern in full.

Connect / OAuth

The full connect flow, error codes, and retry.

Multi-tenancy

One flag and every user gets their own data and credentials.

Get Started

Frameworks

Adapters

Workflows (beta)

Reference

Install

Create the instance

Mount the handler

Resolve the tenant

Read and write

Connect a tenant

Go green

Deploy

Next

Vanilla client

Build a dashboard

Connect / OAuth

Multi-tenancy

​Install

​Create the instance

​Mount the handler

​Resolve the tenant

​Read and write

​Connect a tenant

​Go green

​Deploy

​Next

Vanilla client

Build a dashboard

Connect / OAuth

Multi-tenancy

Install

Create the instance

Mount the handler

Resolve the tenant

Read and write

Connect a tenant

Go green

Deploy

Next