@nest-arch/tui 0.2.8 → 0.4.3

package/dist/templates/base/test/bootstrap.e2e-spec.ts.hbs

@@ -0,0 +1,84 @@
+import { setTimeout as delay } from "node:timers/promises";
+import { once } from "node:events";
+import { createServer } from "node:net";
+import { spawn, type ChildProcess } from "node:child_process";
+
+import { afterEach, expect, it } from "vitest";
+
+const startedProcesses: ChildProcess[] = [];
+
+async function getFreePort(): Promise<number> {
+  const server = createServer();
+  server.listen(0, "127.0.0.1");
+  await once(server, "listening");
+  const address = server.address();
+  server.close();
+  if (!address || typeof address === "string") {
+    throw new Error("Could not allocate a loopback port for the bootstrap test.");
+  }
+  return address.port;
+}
+
+async function waitForServer(url: string, application: ChildProcess, deadline = Date.now() + 15000): Promise<Response> {
+  if (application.exitCode !== null) throw new Error(`Generated application exited during startup with code ${application.exitCode}.`);
+  try {
+    return await fetch(url, { signal: AbortSignal.timeout(500) });
+  } catch (error) {
+    if (Date.now() >= deadline) throw new Error("Generated application did not become ready", { cause: error });
+    await delay(100);
+    return waitForServer(url, application, deadline);
+  }
+}
+
+async function stopApplication(application: ChildProcess): Promise<void> {
+  if (application.exitCode !== null) return;
+  const exited = once(application, "exit");
+  application.kill();
+  const timeout = setTimeout(() => { application.kill("SIGKILL"); }, 5000);
+  try { await exited; } finally { clearTimeout(timeout); }
+}
+
+afterEach(async () => {
+  await Promise.all(startedProcesses.splice(0).map(stopApplication));
+});
+
+it("boots the compiled application through main.ts", async () => {
+  const port = await getFreePort();
+  const origin = "https://allowed.example";
+  const application = spawn(process.execPath, ["dist/main.js"], {
+    env: {
+      ...process.env,
+      CORS_ORIGIN: origin,
+{{#if (and isPassportAuth (not hasDatabase))}}
+      OIDC_AUDIENCE: "generated-resource-server",
+      OIDC_ISSUER: "https://identity.example.test/",
+      OIDC_JWKS_URI: "https://identity.example.test/.well-known/jwks.json",
+{{/if}}
+      NODE_ENV: "test",
+      PORT: String(port),
+    },
+    stdio: ["ignore", "pipe", "pipe"],
+  });
+  startedProcesses.push(application);
+  let output = "";
+  application.stdout?.on("data", (chunk) => { output += chunk.toString(); });
+  application.stderr?.on("data", (chunk) => { output += chunk.toString(); });
+
+{{#if hasRest}}
+  const response = await waitForServer(`http://127.0.0.1:${port}/api`, application).catch((error) => { throw new Error(`${error}\n${output}`); });
+  expect(response.status).toBe(200);
+  expect(await response.text()).toBe("Hello World!");
+
+  const corsResponse = await fetch(`http://127.0.0.1:${port}/api`, {
+    headers: { Origin: origin },
+  });
+  expect(corsResponse.headers.get("access-control-allow-origin")).toBe(origin);
+  const rootResponse = await fetch(`http://127.0.0.1:${port}/`, { redirect: "manual" });
+  expect(rootResponse.status).toBe(404);
+{{else}}
+  await waitForServer(`http://127.0.0.1:${port}/graphql?query=%7Bhello%7D`, application).catch((error) => { throw new Error(`${error}\n${output}`); });
+  const response = await fetch(`http://127.0.0.1:${port}/graphql`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ query: "{ hello }" }) });
+  const body = await response.json();
+  expect(body.data.hello).toBe("Hello GraphQL!");
+{{/if}}
+}, 20_000);

package/dist/templates/base/tsconfig.build.json.hbs

@@ -1,5 +1,6 @@
 {
   "extends": "./tsconfig.json",
+  "include": ["src/**/*.ts"],
   "exclude": [
     "node_modules",
     "test",
@@ -7,6 +8,7 @@
     "**/*spec.ts"
   ],
   "compilerOptions": {
+    "rootDir": "./src",
     "strictNullChecks": true
   }
 }

package/dist/templates/base/vitest.config.e2e.ts.hbs

@@ -1,11 +1,12 @@
 import { defineConfig } from "vitest/config";
-import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
-  plugins: [tsconfigPaths()],
+  resolve: {
+    tsconfigPaths: true,
+  },
   test: {
+    include: ["**/*.e2e-spec.ts"],
     globals: true,
     root: "./",
-    include: ["**/*.e2e-spec.ts"],
   },
 });

package/dist/templates/base/vitest.config.ts.hbs

@@ -1,11 +1,12 @@
 import { defineConfig } from "vitest/config";
-import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
-  plugins: [tsconfigPaths()],
+  resolve: {
+    tsconfigPaths: true,
+  },
   test: {
+    include: ["**/*.spec.ts"],
     globals: true,
     root: "./",
-    include: ["**/*.spec.ts"],
   },
 });

package/dist/templates/base/yarn.lock.hbs

@@ -0,0 +1 @@
+# This lockfile marks the generated application as an independent Yarn project.

package/dist/templates/extras/docker/.dockerignore.hbs

@@ -1 +1,8 @@
-node_modules dist npm-debug.log .env
+node_modules
+dist
+npm-debug.log
+.env
+.env.*
+!.env.example
+!.env.test.example
+.git

package/dist/templates/extras/docker/Dockerfile.hbs

@@ -3,20 +3,21 @@ FROM node:22-alpine
 WORKDIR /app
 
 {{#if (eq packageManager "pnpm")}}
-RUN corepack enable && corepack prepare pnpm@latest --activate
-COPY package.json pnpm-lock.yaml ./
-RUN pnpm install --frozen-lockfile
+RUN corepack enable
 {{else if (eq packageManager "yarn")}}
-COPY package.json yarn.lock ./
-RUN yarn install --frozen-lockfile
+RUN corepack enable
 {{else}}
-COPY package*.json ./
-RUN npm ci
 {{/if}}
 
 COPY . .
-RUN {{packageManager}} run build
+RUN POSTGRES_URL=postgresql://postgres:postgres@postgres:5432/build_db MYSQL_URL=mysql://root:mysql@mysql:3306/build_db MONGODB_URL=mongodb://mongodb:27017/build_db {{#if (eq auth "passport")}}JWT_ACCESS_SECRET=build-only-access-secret-that-is-long-enough JWT_REFRESH_SECRET=build-only-refresh-secret-that-is-long-enough {{/if}}{{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}BETTER_AUTH_SECRET=build-only-better-auth-secret-that-is-long-enough BETTER_AUTH_URL=http://localhost:{{#if (eq httpProvider "fastify")}}3001{{else}}3000{{/if}} {{/if}}{{#if (eq packageManager "pnpm")}}pnpm install --no-lockfile{{else if (eq packageManager "yarn")}}yarn install{{else if (eq packageManager "bun")}}bun install{{else}}npm install{{/if}}
+RUN {{#if (eq packageManager "pnpm")}}pnpm run{{else if (eq packageManager "yarn")}}yarn{{else if (eq packageManager "bun")}}bun run{{else}}npm run{{/if}} build
 
-EXPOSE 3000
+ENV NODE_ENV=production
 
-CMD ["{{packageManager}}", "run", "start:prod"]
+EXPOSE {{#if (eq httpProvider "fastify")}}3001{{else}}3000{{/if}}
+{{#if (includes microservices "grpc")}}
+EXPOSE 5000
+{{/if}}
+
+CMD ["node", "dist/main"]

package/dist/templates/extras/health/src/health/health.controller.ts.hbs

@@ -0,0 +1,54 @@
+import { Controller, Get } from "@nestjs/common";
+import { HealthCheck, HealthCheckService } from "@nestjs/terminus";
+{{#if isBetterAuth}}
+import { AllowAnonymous } from "@thallesp/nestjs-better-auth";
+{{/if}}
+{{#if hasDatabase}}
+import { DbService } from "../database/db.service.js";
+{{#if useDrizzle}}
+import { sql } from "drizzle-orm";
+{{/if}}
+{{/if}}
+
+{{#if isBetterAuth}}
+@AllowAnonymous()
+{{/if}}
+@Controller("health")
+export class HealthController {
+  constructor(
+    private readonly health: HealthCheckService{{#if hasDatabase}},
+    private readonly db: DbService{{/if}}
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  check() {
+    return this.health.check([
+      () => ({ app: { status: "up" } }),
+      {{#if hasDatabase}}
+      async () => {
+        try {
+        {{#if (or usePrisma isPrisma8)}}
+        await this.db.prisma.$queryRaw`SELECT 1`;
+        {{else if useDrizzle}}
+        {{#if hasSqlite}}
+        await this.db.drizzle.get(sql`SELECT 1`);
+        {{else}}
+        await this.db.drizzle.execute(sql`SELECT 1`);
+        {{/if}}
+        {{else if useTypeorm}}
+        await this.db.typeorm.query("SELECT 1");
+        {{else if hasMongodb}}
+        await this.db.raw.mongo.command({ ping: 1 });
+        {{else}}
+        await this.db.raw.sql.query("SELECT 1");
+        {{/if}}
+        return { db: { status: "up" } };
+        } catch {
+          return { db: { status: "down" } };
+        }
+      },
+      {{/if}}
+    ]);
+  }
+}

package/dist/templates/extras/health/src/health/health.module.ts.hbs

@@ -0,0 +1,9 @@
+import { Module } from "@nestjs/common";
+import { TerminusModule } from "@nestjs/terminus";
+import { HealthController } from "./health.controller.js";
+
+@Module({
+  controllers: [HealthController],
+  imports: [TerminusModule],
+})
+export class HealthModule {}

package/dist/templates/extras/swagger/create-docs.ts.hbs

@@ -1,7 +1,3 @@
-// @ts-nocheck
-/* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access, import/no-unresolved */
-/* oxlint-disable import/no-unresolved */
-// oxlint-disable no-unused-vars
 
 import type { INestApplication } from "@nestjs/common";
 import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
@@ -23,6 +19,7 @@ interface DocsIntegrations {
   zod?: {
     withFastify?: boolean;
   };
+  bearerAuth?: boolean;
 }
 
 export interface CreateDocsOptions {
@@ -80,7 +77,8 @@ async function applyZodCleanup(
   options?: NonNullable<DocsIntegrations["zod"]>
 ) {
   try {
-    const { cleanupOpenApiDoc } = await import("nestjs-zod");
+    const packageName = "nestjs-zod";
+    const { cleanupOpenApiDoc } = await import(packageName);
     if (typeof cleanupOpenApiDoc !== "function") {
       return baseSpec;
     }
@@ -143,7 +141,8 @@ async function applyTrpcSpec(options?: NonNullable<DocsIntegrations["trpc"]>) {
   }
 
   try {
-    const { generateOpenAPIDocument } = await import("@trpc/openapi");
+    const packageName = "@trpc/openapi";
+    const { generateOpenAPIDocument } = await import(packageName);
 
     if (typeof generateOpenAPIDocument !== "function") {
       return null;
@@ -174,28 +173,20 @@ async function applyTrpcSpec(options?: NonNullable<DocsIntegrations["trpc"]>) {
   }
 }
 
-function createEmptyBaseSpec(options: CreateDocsOptions): OpenAPIObject {
-  return {
-    info: {
-      description: options.description ?? "Generated with Nest Arch",
-      title: options.title ?? "NestJS API",
-      version: options.version ?? "1.0.0",
-    },
-    openapi: "3.1.0",
-    paths: {},
-    tags: [],
-  } as OpenAPIObject;
-}
-
 export async function createDocs(
   app: INestApplication,
   options: CreateDocsOptions = {}
 ): Promise<OpenAPIObject> {
-  const config = new DocumentBuilder()
+  const builder = new DocumentBuilder()
     .setTitle(options.title ?? "NestJS API")
     .setDescription(options.description ?? "Generated with Nest Arch")
-    .setVersion(options.version ?? "1.0.0")
-    .build();
+    .setVersion(options.version ?? "1.0.0");
+
+  if (options.integrations?.bearerAuth === true) {
+    builder.addBearerAuth();
+  }
+
+  const config = builder.build();
 
   let baseSpec = SwaggerModule.createDocument(app, config) as OpenAPIObject;
   baseSpec = await applyZodCleanup(baseSpec, options.integrations?.zod);

package/dist/templates/feature/graphql/src/graphql/graphql.module.ts.hbs

@@ -1,13 +1,10 @@
 import { Module } from "@nestjs/common";
 import { GraphQLModule } from "@nestjs/graphql";
 import { ApolloDriver, ApolloDriverConfig } from "@nestjs/apollo";
-import { join } from "path";
+import type { IncomingMessage } from "node:http";
+import path from "node:path";
 import { env } from "../config/env.js";
-{{#if (eq httpProvider "fastify")}}
-// WARNING: If you use @as-integrations/fastify with multiple GraphQL endpoints
-// in a single application, make sure to enable the disableHealthCheck setting
-// in the GraphQLModule configuration below.
-{{/if}}
+import { HealthResolver } from "./resolvers/health.resolver.js";
 {{#if hasTodoExample}}
 import { TodoResolver } from "./resolvers/todo.resolver.js";
 {{/if}}
@@ -16,15 +13,14 @@ import { TodoResolver } from "./resolvers/todo.resolver.js";
   imports: [
     GraphQLModule.forRoot<ApolloDriverConfig>({
       driver: ApolloDriver,
-      autoSchemaFile: join(process.cwd(), "src/schema.gql"),
+      autoSchemaFile: path.join(process.cwd(), "src/schema.gql"),
       graphiql: env.GRAPHQL_PLAYGROUND,
+      context: ({ req, res }: { req: IncomingMessage; res: unknown }) => ({ req, res }),
       sortSchema: true,
-      {{#if (eq httpProvider "fastify")}}
-      disableHealthCheck: true,
-      {{/if}}
     }),
   ],
   providers: [
+    HealthResolver,
     {{#if hasTodoExample}}
     TodoResolver,
     {{/if}}

package/dist/templates/feature/graphql/src/graphql/models/todo.model.ts.hbs

@@ -1,8 +1,10 @@
 import { Field, ID, ObjectType } from "@nestjs/graphql";
 
 import { BaseModel } from "./base.model.js";
+{{#if hasAuth}}
 // oxlint-disable-next-line import/no-cycle
 import { User } from "./user.model.js";
+{{/if}}
 
 @ObjectType()
 export class Todo extends BaseModel {
@@ -15,9 +17,11 @@ export class Todo extends BaseModel {
   @Field()
   completed: boolean;
 
+{{#if hasAuth}}
   @Field(() => ID, { nullable: true })
   authorId: string | null;
 
   @Field(() => User, { nullable: true })
   author: User | null;
+{{/if}}
 }

package/dist/templates/feature/graphql/src/graphql/orm/drizzle/drizzle-graphql.module.ts.hbs

@@ -3,6 +3,7 @@ import { buildSchema } from "drizzle-graphql";
 {{#if isMonorepo}}
 import { db } from "@repo/db";
 {{else}}
+import { env } from "../../../config/env.js";
   {{#if hasPostgres}}
 import { drizzle } from "drizzle-orm/node-postgres";
 import { Pool } from "pg";
@@ -15,21 +16,22 @@ import mysql from "mysql2";
 import { drizzle } from "drizzle-orm/better-sqlite3";
 import Database from "better-sqlite3";
   {{/if}}
-import * as dbSchema from "../database/orm/drizzle/schema.js";
+import * as dbSchema from "../../../database/orm/drizzle/schema.js";
 {{/if}}
 
 const schema = buildSchema({{#if isMonorepo}}db{{else}}
   {{#if hasPostgres}}
-  drizzle(new Pool({ connectionString: process.env.DATABASE_URL }), { schema: dbSchema })
+  drizzle(new Pool({ connectionString: env.POSTGRES_URL }), { schema: dbSchema })
   {{/if}}
   {{#if hasMysql}}
-  drizzle(mysql.createPool(process.env.DATABASE_URL), { schema: dbSchema })
+  drizzle(mysql.createPool(env.MYSQL_URL), { mode: "default", schema: dbSchema })
   {{/if}}
   {{#if hasSqlite}}
-  drizzle(new Database(process.env.DATABASE_URL), { schema: dbSchema })
+  drizzle(new Database(env.SQLITE_PATH), { schema: dbSchema })
   {{/if}}
 {{/if}});
 
+
 @Module({
   providers: [
     {

package/dist/templates/feature/graphql/src/graphql/resolvers/health.resolver.ts.hbs

@@ -0,0 +1,14 @@
+import { Query, Resolver } from "@nestjs/graphql";
+{{#if isBetterAuth}}
+import { AllowAnonymous } from "@thallesp/nestjs-better-auth";
+{{/if}}
+{{#if isBetterAuth}}
+@AllowAnonymous()
+{{/if}}
+@Resolver()
+export class HealthResolver {
+  @Query(() => String)
+  hello(): string {
+    return "Hello GraphQL!";
+  }
+}