Codegen

pnpm nestjs-codegen

// nestjs-codegen.config.ts
import { defineConfig } from '@dudousxd/nestjs-codegen';
import { nestjsInertiaCodegen } from '@dudousxd/nestjs-inertia-codegen-extension';

export default defineConfig({
  pages: {
    glob: 'inertia/pages/**/*.tsx',
  },
  app: {
    moduleEntry: './src/app.module.ts',
  },
  contracts: {
    glob: 'src/**/*.controller.ts',
    debounceMs: 500,
  },
  codegen: {
    outDir: '.nestjs-inertia',
  },
  extensions: [nestjsInertiaCodegen()],
});

extensions: [
  nestjsInertiaCodegen({
    // Emit shared.ts — the `InertiaSharedProps` type
    shared: { module: './src/shared-props.ts', export: 'getSharedProps', kind: 'function' },
    // Emit page-excludes.ts — every @Inertia page route (path + method)
    pageExcludes: true,
  }),
],

// kind: 'function' — reads ReturnType of the share factory
shared: { module: './src/shared-props.ts', export: 'getSharedProps', kind: 'function' }
// kind: 'type' — the export is already the shape
shared: { module: './src/types.ts', export: 'SharedProps', kind: 'type' }

import { pageExcludes } from './.nestjs-inertia/page-excludes.js';

app.setGlobalPrefix('api', { exclude: pageExcludes });

pnpm nestjs-codegen

{
  "scripts": {
    "codegen": "nestjs-codegen"
  }
}

.nestjs-inertia/
  pages.d.ts   — module augmentation for typed @Inertia() and page props
  routes.ts    — typed route map + route() helper for URL resolution
  api.ts       — queryOptions(), mutationOptions(), queryKey() for every route

export type InertiaPageName = 'Dashboard' | 'Users' | 'Settings';

declare module '@dudousxd/nestjs-inertia' {
  interface InertiaPages {
    Dashboard: Parameters<typeof import('../inertia/pages/Dashboard').default>[0];
    Users: Parameters<typeof import('../inertia/pages/Users').default>[0];
    Settings: Parameters<typeof import('../inertia/pages/Settings').default>[0];
  }
}

export const ROUTES = {
  "users.list": "/api/users",
  "users.show": "/api/users/:id",
} as const;

export type RouteName = keyof typeof ROUTES;

export function route(name: RouteName, params?: Record<string, string>): string;

route('users.show', { id: '42' })
// → "/api/users/42"

import { queryOptions as _queryOptions, mutationOptions as _mutationOptions } from '@tanstack/react-query';
import type { Jsonify } from '@dudousxd/nestjs-inertia-client';

export interface ApiRouter {
  users: {
    list: {
      method: "GET";
      url: "/api/users";
      query: { active?: boolean };
      body: never;
      response: Jsonify<Awaited<ReturnType<import('../src/users.controller').UsersController['list']>>>;
    };
    show: {
      method: "GET";
      url: "/api/users/:id";
      params: { id: string };
      query: never;
      body: never;
      response: Jsonify<Awaited<ReturnType<import('../src/users.controller').UsersController['show']>>>;
    };
  };
}

export const api = {
  users: {
    list: {
      queryOptions: (query?) => _queryOptions({ queryKey: ["users.list", query], queryFn: () => fetcher.get("/api/users", { query }) }),
      queryKey: (query?) => ["users.list", query] as const,
    },
    show: {
      queryOptions: (params, query?) => _queryOptions({ queryKey: ["users.show", params, query], queryFn: () => fetcher.get(`/api/users/${params.id}`, { query }) }),
      queryKey: (params, query?) => ["users.show", params, query] as const,
    },
  },
};

import { Controller, Get, Param } from '@nestjs/common';

class OrderDto {
  id: string;
  total: number;
  placedAt: Date;       // ← Date on the server
}

@Controller('/api/orders')
export class OrdersController {
  @Get(':id')
  show(@Param('id') id: string): Promise<OrderDto> {
    return this.ordersService.findOne(id);
  }
}

import { defineConfig } from '@dudousxd/nestjs-codegen';
import { nestjsInertiaCodegen } from '@dudousxd/nestjs-inertia-codegen-extension';

export default defineConfig({
  pages: { glob: 'inertia/pages/**/*.tsx' },
  app: { moduleEntry: './src/app.module.ts' },
  serialization: 'superjson',   // emit raw types — your fetcher revives the payload
  extensions: [nestjsInertiaCodegen()],
});

import { Body, Controller, Get, Param, Post, Query } from '@nestjs/common';
import { ApiResponse } from '@nestjs/swagger';

class ListPostsQuery {
  page?: number;
}

class PostDto {
  id: string;
  title: string;
}

class CreatePostBody {
  title: string;
  content: string;
}

@Controller('/api/posts')
export class PostsController {
  @Get()
  @ApiResponse({ type: [PostDto] })
  list(@Query() query: ListPostsQuery): Promise<PostDto[]> {
    return this.postsService.list(query);
  }

  @Post()
  @ApiResponse({ type: PostDto })
  create(@Body() body: CreatePostBody): Promise<PostDto> {
    return this.postsService.create(body);
  }

  @Get(':id')
  @ApiResponse({ type: PostDto })
  show(@Param('id') id: string): Promise<PostDto> {
    return this.postsService.findOne(id);
  }
}

// src/dto/post.dto.ts
export class PostDto {
  id: string;
  title: string;
}

// src/posts.controller.ts
import { PostDto } from './dto/post.dto';

@Controller('/api/posts')
export class PostsController {
  @Get()
  list(): Promise<PostDto[]> {
    return this.postsService.list();
  }
}

import { As } from '@dudousxd/nestjs-inertia-client';

@Controller('/api/v1/crew')
@As('crew')
class CrewController {
  @Get()
  list() {}              // → 'crew.list'

  @Get('/top')
  @As('top10')           // → 'crew.top10'
  top() {}
}

@Controller('/api/v1/admin/crew')
@As('crew.admin')
class CrewAdminController {
  @Get()
  @As('top10')           // → 'crew.admin.top10'
  list() {}
}

import type { Route } from '~codegen/api';

type UserList = Route.Response<'users.list'>;

type CreateUserRequest = Route.Request<'users.create'>;
// → { body: { name: string; email: string }; query: never; params: never }

import type { Path } from '~codegen/api';

type ListResponse = Path.Response<'GET', '/api/users'>;
type CreateBody   = Path.Body<'POST', '/api/users'>;

InertiaModule.forRoot({
  codegen: { enabled: false },
});

pnpm nestjs-codegen --watch

pnpm exec nestjs-inertia doctor