@nest-arch/tui 0.2.0 → 0.2.1

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

@@ -0,0 +1,33 @@
+import { Module } from "@nestjs/common";
+import { GraphQLModule } from "@nestjs/graphql";
+import { ApolloDriver, ApolloDriverConfig } from "@nestjs/apollo";
+import { join } from "path";
+import { env } from "@repo/env/api-gateway";
+{{#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}}
+{{#if hasTodoExample}}
+import { TodoResolver } from "./resolvers/todo.resolver.js";
+{{/if}}
+
+@Module({
+  imports: [
+    GraphQLModule.forRoot<ApolloDriverConfig>({
+      driver: ApolloDriver,
+      autoSchemaFile: join(process.cwd(), "apps/api-gateway/src/schema.gql"),
+      graphiql: env.GRAPHQL_PLAYGROUND,
+      sortSchema: true,
+      {{#if (eq httpProvider "fastify")}}
+      disableHealthCheck: true,
+      {{/if}}
+    }),
+  ],
+  providers: [
+    {{#if hasTodoExample}}
+    TodoResolver,
+    {{/if}}
+  ],
+})
+export class GraphqlAppModule {}

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

@@ -0,0 +1,13 @@
+import { Field, ID, ObjectType } from "@nestjs/graphql";
+
+@ObjectType({ isAbstract: true })
+export abstract class BaseModel {
+  @Field(() => ID)
+  id: string;
+
+  @Field()
+  createdAt: Date;
+
+  @Field()
+  updatedAt: Date;
+}

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

@@ -0,0 +1,23 @@
+import { Field, ID, ObjectType } from "@nestjs/graphql";
+
+import { BaseModel } from "./base.model.js";
+// oxlint-disable-next-line import/no-cycle
+import { User } from "./user.model.js";
+
+@ObjectType()
+export class Todo extends BaseModel {
+  @Field()
+  title: string;
+
+  @Field(() => String, { nullable: true })
+  description: string | null;
+
+  @Field()
+  completed: boolean;
+
+  @Field(() => ID, { nullable: true })
+  authorId: string | null;
+
+  @Field(() => User, { nullable: true })
+  author: User | null;
+}

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

@@ -0,0 +1,34 @@
+import { Field, ObjectType, registerEnumType } from "@nestjs/graphql";
+
+import { BaseModel } from "./base.model.js";
+{{#if hasTodoExample}}
+// oxlint-disable-next-line import/no-cycle
+import { Todo } from "./todo.model.js";
+{{/if}}
+
+export enum Role {
+  ADMIN = "ADMIN",
+  USER = "USER",
+}
+
+registerEnumType(Role, { name: "Role" });
+
+@ObjectType()
+export class User extends BaseModel {
+  @Field()
+  email: string;
+
+  @Field(() => String, { nullable: true })
+  firstname: string | null;
+
+  @Field(() => String, { nullable: true })
+  lastname: string | null;
+
+  @Field(() => Role)
+  role: Role;
+{{#if hasTodoExample}}
+
+  @Field(() => [Todo], { nullable: "items" })
+  todos: Todo[];
+{{/if}}
+}

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

@@ -0,0 +1,16 @@
+import { Module } from "@nestjs/common";
+import { buildSchema } from "drizzle-graphql";
+import { db } from "@repo/db";
+
+const schema = buildSchema(db);
+
+@Module({
+  providers: [
+    {
+      provide: "DRIZZLE_GRAPHQL_SCHEMA",
+      useValue: schema,
+    },
+  ],
+  exports: ["DRIZZLE_GRAPHQL_SCHEMA"],
+})
+export class DrizzleGraphqlModule {}

package/dist/templates/monorepo/feature/graphql/src/graphql/orm/prisma/prisma-graphql.service.ts.hbs

@@ -0,0 +1,9 @@
+import { Injectable, OnModuleInit } from "@nestjs/common";
+import { PrismaClient } from "@prisma/client";
+
+@Injectable()
+export class PrismaGraphqlService extends PrismaClient implements OnModuleInit {
+  async onModuleInit(): Promise<void> {
+    await this.$connect();
+  }
+}

package/dist/templates/monorepo/feature/graphql/src/graphql/orm/typeorm/typeorm-graphql-relations.helper.ts.hbs

@@ -0,0 +1,23 @@
+import { GraphQLResolveInfo } from "graphql";
+import { DataSource, EntityTarget, FindOptionsRelations } from "typeorm";
+import { GraphRelationBuilder } from "typeorm-relations-graphql";
+
+export class TypeOrmGraphqlRelationsHelper {
+  private readonly builder: GraphRelationBuilder;
+
+  constructor(dataSource: DataSource) {
+    this.builder = new GraphRelationBuilder(dataSource);
+  }
+
+  resolve<T>(
+    entity: EntityTarget<T>,
+    info: GraphQLResolveInfo,
+    path?: string
+  ): FindOptionsRelations<T> {
+    const relationMap = path
+      ? this.builder.buildForQuery(entity, info, path)
+      : this.builder.buildForQuery(entity, info);
+
+    return relationMap as unknown as FindOptionsRelations<T>;
+  }
+}

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

@@ -0,0 +1,122 @@
+{{#if (and hasAuth hasDatabase)}}
+import { UseGuards } from "@nestjs/common";
+{{/if}}
+import { Args, Mutation, Query, Resolver } from "@nestjs/graphql";
+import { CreateTodoInput } from "../dto/create-todo.input.js";
+import { UpdateTodoInput } from "../dto/update-todo.input.js";
+import { DbService } from "@repo/db";
+{{#if useTypeorm}}
+import { GraphRelationBuilder } from "typeorm-relations-graphql";
+import { GraphQLResolveInfo } from "graphql";
+{{/if}}
+{{#if useDrizzle}}
+import * as schema from "@repo/db/src/orm/drizzle/schema.js";
+{{/if}}
+{{#if (and hasAuth hasDatabase)}}
+import { Todo } from "../models/todo.model.js";
+import { UserEntity } from "../../auth/decorators/index.js";
+import { GqlAuthGuard } from "../../auth/guards/gql-auth.guard.js";
+{{/if}}
+
+@Resolver({{#if (and hasAuth hasDatabase)}}{{"("}}() => Todo){{/if}})
+export class TodoResolver {
+  constructor(private readonly db: DbService) {}
+
+  @Query(() => String)
+  hello(): string {
+    return "Hello GraphQL!";
+  }{{#if hasDatabase}}
+
+  @Query(() => [Todo])
+  todos({{#if useTypeorm}}info: GraphQLResolveInfo{{/if}}): Promise<Todo[]> {
+    {{#if useTypeorm}}
+    const builder = new GraphRelationBuilder(this.db.getDataSource());
+    const relations = builder.buildForQuery(Todo, info, "todos");
+    return this.db.getRepository(Todo).find({ relations });
+    {{else if usePrisma}}
+    return this.db.prisma.todo.findMany();
+    {{else if useDrizzle}}
+    return this.db.select().from(schema.todos);
+    {{else}}
+    return [];
+    {{/if}}
+  }
+
+  @Mutation(() => Todo)
+  {{#if (and hasAuth hasDatabase)}}
+  @UseGuards(GqlAuthGuard)
+  {{/if}}
+  createTodo(
+    @Args("input") input: CreateTodoInput{{#if (and hasAuth hasDatabase)}},
+    @UserEntity() user: { id: string }{{/if}}{{#if useTypeorm}}, info: GraphQLResolveInfo{{/if}}
+  ): Promise<Todo> {
+    {{#if useTypeorm}}
+    const entity = this.db.getRepository(Todo).create(input);
+    const saved = await this.db.getRepository(Todo).save(entity);
+    const builder = new GraphRelationBuilder(this.db.getDataSource());
+    const relations = builder.buildForQuery(Todo, info, "createTodo");
+    return this.db.getRepository(Todo).findOneOrFail({
+      where: { id: saved.id },
+      relations,
+    });
+    {{else if usePrisma}}
+    return this.db.prisma.todo.create({
+      data: { ...input{{#if (and hasAuth hasDatabase)}}, authorId: user.id{{/if}} },
+    });
+    {{else if useDrizzle}}
+    const [todo] = await this.db.insert(schema.todos).values(input).returning();
+    return todo;
+    {{else}}
+    return { id: "1", ...input };
+    {{/if}}
+  }
+
+  @Mutation(() => Todo)
+  {{#if (and hasAuth hasDatabase)}}
+  @UseGuards(GqlAuthGuard)
+  {{/if}}
+  updateTodo(
+    @Args("input") input: UpdateTodoInput{{#if useTypeorm}}, info: GraphQLResolveInfo{{/if}}
+  ): Promise<Todo> {
+    const { id, ...data } = input;
+    {{#if useTypeorm}}
+    await this.db.getRepository(Todo).update(id, data);
+    const builder = new GraphRelationBuilder(this.db.getDataSource());
+    const relations = builder.buildForQuery(Todo, info, "updateTodo");
+    return this.db.getRepository(Todo).findOneOrFail({
+      where: { id },
+      relations,
+    });
+    {{else if usePrisma}}
+    return this.db.prisma.todo.update({ where: { id }, data });
+    {{else if useDrizzle}}
+    const [todo] = await this.db
+      .update(schema.todos)
+      .set(data)
+      .where(eq(schema.todos.id, id))
+      .returning();
+    return todo;
+    {{else}}
+    return { id, ...data };
+    {{/if}}
+  }
+
+  @Mutation(() => Boolean)
+  {{#if (and hasAuth hasDatabase)}}
+  @UseGuards(GqlAuthGuard)
+  {{/if}}
+  async deleteTodo(@Args("id") id: string): Promise<boolean> {
+    {{#if useTypeorm}}
+    const result = await this.db.getRepository(Todo).delete(id);
+    return (result.affected ?? 0) > 0;
+    {{else if usePrisma}}
+    await this.db.prisma.todo.delete({ where: { id } });
+    return true;
+    {{else if useDrizzle}}
+    await this.db.delete(schema.todos).where(eq(schema.todos.id, id));
+    return true;
+    {{else}}
+    return true;
+    {{/if}}
+  }{{/if}}
+}

package/dist/templates/monorepo/packages/env/src/api-gateway.ts.hbs

@@ -45,5 +45,15 @@ export const env = createEnv({
     {{#if hasMongodb}}
     MONGODB_URL: z.url(),
     {{/if}}
+    {{#if hasGraphql}}
+    GRAPHQL_PLAYGROUND: z
+      .string()
+      .transform((val) => val === "true")
+      .default(true),
+    {{/if}}
+    {{#if (and (eq auth "passport") hasDatabase)}}
+    JWT_ACCESS_SECRET: z.string().min(32),
+    JWT_REFRESH_SECRET: z.string().min(32),
+    {{/if}}
   },
 });

package/dist/templates/monorepo/root/README.md.hbs

@@ -38,7 +38,7 @@
 This project uses **Better Auth**. Generate the database schema by running:
 
 ```bash
-{{#if isPnpm}}pnpm dlx auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y{{else if isYarn}}yarn dlx auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y{{else if isBun}}bun x auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y{{else}}npx auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y{{/if}}
+{{#if isPnpm}}pnpm dlx auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y && pnpm run prisma:format{{else if isYarn}}yarn dlx auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y && yarn run prisma:format && pnpm run prisma:format{{else if isBun}}bun x auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y && bun run prisma:format{{else}}npx auth@latest generate --config src/auth/auth.ts --output src/database/orm/prisma/schema.prisma -y && npm run prisma:format{{/if}}
 ```
 
 {{#if useDrizzle}}Then run Drizzle migrations:

package/dist/templates/monorepo/root/pnpm-workspace.yaml.hbs

@@ -7,6 +7,12 @@ allowBuilds:
 {{#if swagger}}
   '@scarf/scarf': true
 {{/if}}
+{{#if hasGraphql}}
+  '@apollo/protobufjs': true
+{{/if}}
+{{#if (and (eq auth "passport") hasDatabase)}}
+  bcrypt: true
+{{/if}}
 catalog:
   "@types/node": ^22.13.14
   dotenv: ^17.2.2

package/dist/templates/single-project/architecture/nest-api/.env.hbs

@@ -1,2 +1,26 @@
-PORT=3000
 CORS_ORIGIN=http://localhost:3001
+PORT=3000
+{{#if hasGraphql}}
+GRAPHQL_PLAYGROUND=true
+{{/if}}
+
+{{#if hasPostgres}}
+POSTGRES_URL=postgresql://postgres:postgres@localhost:5432/{{projectNameKebab}}_db?schema=public
+{{/if}}
+{{#if hasMysql}}
+MYSQL_URL=mysql://root:mysql@localhost:3306/{{projectNameKebab}}_db
+{{/if}}
+{{#if hasSqlite}}
+SQLITE_PATH=sqlite.db
+{{/if}}
+{{#if hasMongodb}}
+MONGODB_URL=mongodb://localhost:27017/{{projectNameKebab}}_db
+{{/if}}
+{{#if (and (eq auth "passport") hasDatabase)}}
+JWT_ACCESS_SECRET=change-me-to-a-random-secret-at-least-32-characters-long
+JWT_REFRESH_SECRET=change-me-to-a-different-random-secret-at-least-32-characters
+{{/if}}
+{{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
+BETTER_AUTH_SECRET=change-me-to-a-random-secret-at-least-32-characters-long
+BETTER_AUTH_URL=http://localhost:3000
+{{/if}}

package/dist/templates/single-project/architecture/nest-api/pnpm-workspace.yaml.hbs

@@ -3,5 +3,11 @@ allowBuilds:
 {{#if swagger}}
   "@scarf/scarf": true
 {{/if}}
+{{#if hasGraphql}}
+  "@apollo/protobufjs": true
+{{/if}}
+{{#if (and (eq auth "passport") hasDatabase)}}
+  bcrypt: true
+{{/if}}
 catalog:
   dotenv: ^17.2.2

package/dist/templates/single-project/architecture/nest-api/src/main.ts.hbs

@@ -2,7 +2,7 @@ import { NestFactory } from "@nestjs/core";
 {{#if (eq httpProvider "fastify")}}
 import { FastifyAdapter, NestFastifyApplication } from "@nestjs/platform-fastify";
 {{/if}}
-import { Logger } from "@nestjs/common";
+import { Logger, StandardSchemaValidationPipe } from "@nestjs/common";
 
 import { AppModule } from "./app.module.js";
 import { env } from "./config/env.js";
@@ -24,65 +24,71 @@ async function bootstrap() {
   app.enableCors({
     origin: env.CORS_ORIGIN,
   });
+  {{#if hasRest}}
   app.setGlobalPrefix("api");
+  {{/if}}
+  app.useGlobalPipes(new StandardSchemaValidationPipe());
+  app.enableShutdownHooks();
   {{#if swagger}}
-  const docsPath = "/docs";
-  {{#if useSwaggerScalar}}
-  app.use(
-    docsPath,
-    apiReference({
-      content: await createDocs(app, {
-        title: "{{projectNamePascalCase}} API",
-        description: "{{description}}",
-        version: "1.0.0",
-        integrations: {
-          {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
-          betterAuth: {
-            auth,
-            pathPrefix: "/api/auth",
-          },
-          {{/if}}
-          {{#if (includes apis "trpc")}}
-          trpc: {
-            routerFilePath: "./src/trpc/router.ts",
-            pathPrefix: "/trpc",
-          },
-          {{/if}}
-          zod: {
-            withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
+  if (env.NODE_ENV === "development") {
+    const docsPath = "/docs";
+    {{#if useSwaggerScalar}}
+    app.use(
+      docsPath,
+      apiReference({
+        content: await createDocs(app, {
+          title: "{{projectNamePascalCase}} API",
+          description: "{{description}}",
+          version: "1.0.0",
+          integrations: {
+            {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
+            betterAuth: {
+              auth,
+              pathPrefix: "/api/auth",
+            },
+            {{/if}}
+            {{#if (includes apis "trpc")}}
+            trpc: {
+              routerFilePath: "./src/trpc/router.ts",
+              pathPrefix: "/trpc",
+            },
+            {{/if}}
+            zod: {
+              withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
+            },
           },
-        },
+        }),
+        pageTitle: "{{projectNamePascalCase}} API Docs",
+        theme: "default",
       }),
-      pageTitle: "{{projectNamePascalCase}} API Docs",
-      theme: "default",
-    }),
-  );
-  {{else}}
-  const document = await createDocs(app, {
-    title: "{{projectNamePascalCase}} API",
-    description: "{{description}}",
-    version: "1.0.0",
-    integrations: {
-      {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
-       betterAuth: {
-        auth,
-        pathPrefix: "/api/auth",
-      },
-      {{/if}}
-      {{#if (includes apis "trpc")}}
-      trpc: {
-        routerFilePath: "./src/trpc/router.ts",
-        pathPrefix: "/trpc",
-      },
-      {{/if}}
-      zod: {
-        withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
+    );
+    {{else}}
+    const document = await createDocs(app, {
+      title: "{{projectNamePascalCase}} API",
+      description: "{{description}}",
+      version: "1.0.0",
+      integrations: {
+        {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
+        betterAuth: {
+          auth,
+          pathPrefix: "/api/auth",
+        },
+        {{/if}}
+        {{#if (includes apis "trpc")}}
+        trpc: {
+          routerFilePath: "./src/trpc/router.ts",
+          pathPrefix: "/trpc",
+        },
+        {{/if}}
+        zod: {
+          withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
+        },
       },
-    },
-  });
-  SwaggerModule.setup(docsPath, app, document);
-  {{/if}}
-  Logger.log(`Swagger documentation available at http://localhost:${env.PORT ?? 3000}${docsPath}`, "SwaggerDocs");
+    });
+    SwaggerModule.setup(docsPath, app, document);
+    {{/if}}
+    Logger.log(`Swagger documentation available at http://localhost:${env.PORT ?? 3000}${docsPath}`, "SwaggerDocs");
+  }
   {{/if}}
 
   await app.listen(env.PORT ?? 3000);

package/dist/templates/single-project/architecture/nest-gateway/src/main.ts.hbs

@@ -26,63 +26,65 @@ async function bootstrap() {
   });
   app.setGlobalPrefix("api");
   {{#if swagger}}
-  const docsPath = "/docs";
-  {{#if useSwaggerScalar}}
-  app.use(
-    docsPath,
-    apiReference({
-      content: await createDocs(app, {
-        title: "{{projectNamePascalCase}} API",
-        description: "{{description}}",
-        version: "1.0.0",
-        integrations: {
-          {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
-          betterAuth: {
-            auth,
-            pathPrefix: "/api/auth",
+  if (env.NODE_ENV === "development") {
+    const docsPath = "/docs";
+    {{#if useSwaggerScalar}}
+    app.use(
+      docsPath,
+      apiReference({
+        content: await createDocs(app, {
+          title: "{{projectNamePascalCase}} API",
+          description: "{{description}}",
+          version: "1.0.0",
+          integrations: {
+            {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
+            betterAuth: {
+              auth,
+              pathPrefix: "/api/auth",
+            },
+            {{/if}}
+            {{#if (includes apis "trpc")}}
+            trpc: {
+              routerFilePath: "./src/trpc/router.ts",
+              pathPrefix: "/trpc",
+            },
+            {{/if}}
+            zod: {
+              withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
+            },
           },
-          {{/if}}
-          {{#if (includes apis "trpc")}}
-          trpc: {
-            routerFilePath: "./src/trpc/router.ts",
-            pathPrefix: "/trpc",
-          },
-          {{/if}}
-          zod: {
-            withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
-          },
-        },
+        }),
+        pageTitle: "{{projectNamePascalCase}} API Docs",
+        theme: "default",
       }),
-      pageTitle: "{{projectNamePascalCase}} API Docs",
-      theme: "default",
-    }),
-  );
-  {{else}}
-  const document = await createDocs(app, {
-    title: "{{projectNamePascalCase}} API",
-    description: "{{description}}",
-    version: "1.0.0",
-    integrations: {
-      {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
-       betterAuth: {
-        auth,
-        pathPrefix: "/api/auth",
-      },
-      {{/if}}
-      {{#if (includes apis "trpc")}}
-      trpc: {
-        routerFilePath: "./src/trpc/router.ts",
-        pathPrefix: "/trpc",
-      },
-      {{/if}}
-      zod: {
-        withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
+    );
+    {{else}}
+    const document = await createDocs(app, {
+      title: "{{projectNamePascalCase}} API",
+      description: "{{description}}",
+      version: "1.0.0",
+      integrations: {
+        {{#if (or (eq auth "better-auth") (eq auth "better-auth:stateless"))}}
+        betterAuth: {
+          auth,
+          pathPrefix: "/api/auth",
+        },
+        {{/if}}
+        {{#if (includes apis "trpc")}}
+        trpc: {
+          routerFilePath: "./src/trpc/router.ts",
+          pathPrefix: "/trpc",
+        },
+        {{/if}}
+        zod: {
+          withFastify: {{#if (eq httpProvider "fastify")}}true{{else}}false{{/if}},
+        },
       },
-    },
-  });
-  SwaggerModule.setup(docsPath, app, document);
-  {{/if}}
-  Logger.log(`Swagger documentation available at http://localhost:${env.PORT ?? 3000}${docsPath}`, "SwaggerDocs");
+    });
+    SwaggerModule.setup(docsPath, app, document);
+    {{/if}}
+    Logger.log(`Swagger documentation available at http://localhost:${env.PORT ?? 3000}${docsPath}`, "SwaggerDocs");
+  }
   {{/if}}
 
   await app.listen(env.PORT ?? 3000);

package/dist/templates/single-project/architecture/nest-microservice/.env.hbs

@@ -1,3 +1,6 @@
 PORT=3000
 MICROSERVICE_PORT=3001
 CORS_ORIGIN=http://localhost:3001
+{{#if hasGraphql}}
+GRAPHQL_PLAYGROUND=true
+{{/if}}