@nest-arch/tui 0.2.0 → 0.2.1

package/dist/templates/base/.env.example.hbs

@@ -0,0 +1,36 @@
+# Server
+PORT=3000
+NODE_ENV=development
+CORS_ORIGIN=http://localhost:3001
+
+{{#if hasDatabase}}
+# Database
+{{/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 hasGraphql}}
+# GraphQL
+GRAPHQL_PLAYGROUND=true
+
+{{/if}}
+{{#if (and (eq auth "passport") hasDatabase)}}
+# JWT
+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
+BETTER_AUTH_SECRET=change-me-to-a-random-secret-at-least-32-characters-long
+BETTER_AUTH_URL=http://localhost:3000
+{{/if}}

package/dist/templates/base/.env.hbs

@@ -1,5 +1,8 @@
 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
@@ -13,6 +16,10 @@ SQLITE_PATH=sqlite.db
 {{#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

package/dist/templates/base/README.md.hbs

@@ -82,7 +82,7 @@ This project uses **TypeORM** as the ORM. Available commands:
 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{{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}}
 ```
 See https://better-auth.com/docs/adapters/prisma for more details.
 

package/dist/templates/base/pnpm-workspace.yaml.hbs

@@ -3,7 +3,13 @@ allowBuilds:
 {{#if swagger}}
   "@scarf/scarf": true
 {{/if}}
+{{#if hasGraphql}}
+  "@apollo/protobufjs": true
+{{/if}}
 {{#if usePrisma}}
   prisma: true
   "@prisma/engines": true
 {{/if}}
+{{#if (and (eq auth "passport") hasDatabase)}}
+  bcrypt: true
+{{/if}}

package/dist/templates/base/src/app.module.ts.hbs

@@ -6,6 +6,9 @@ import { DbModule } from "./database/db.module.js";
 {{#if shouldImportAuthModule}}
 import { AuthModule } from "./auth/auth.module.js";
 {{/if}}
+{{#if hasGraphql}}
+import { GraphqlAppModule } from "./graphql/graphql.module.js";
+{{/if}}
 {{#if hasTrpc}}
 import { TRPCModule } from "nestjs-trpc";
 import { AppRouterClass as AppRouter } from "./app.router.js";
@@ -19,11 +22,19 @@ import { AuthTRPCMiddleware } from "./libs/middlewares/auth.trpc.middleware.js";
 {{#if hasRest}}
 import { AppController } from "./app.controller.js";
 {{/if}}
+{{#if (and hasTodoExample hasRest)}}
+import { TodoController } from "./api/todo/todo.controller.js";
+{{/if}}
 import { AppService } from "./app.service.js";
 
 @Module({
   {{#if hasRest}}
-  controllers: [AppController],
+  controllers: [
+    AppController,
+    {{#if (and hasTodoExample hasRest)}}
+    TodoController,
+    {{/if}}
+  ],
   {{/if}}
   imports: [
     {{#if (or hasDatabase hasOrm)}}
@@ -37,6 +48,9 @@ import { AppService } from "./app.service.js";
     {{#if shouldImportAuthModule}}
     AuthModule,
     {{/if}}
+    {{#if hasGraphql}}
+    GraphqlAppModule,
+    {{/if}}
     {{#if hasTrpc}}
     TRPCModule.forRoot({
       context: AppContext,

package/dist/templates/base/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,7 +24,11 @@ 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}}

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

@@ -40,6 +40,58 @@ export interface CreateDocsOptions {
   integrations?: DocsIntegrations;
 }
 
+function rewriteRefs(value: unknown): unknown {
+  if (Array.isArray(value)) {
+    return value.map((item) => rewriteRefs(item));
+  }
+  if (!value || typeof value !== "object") {
+    return value;
+  }
+  const obj = value as Record<string, unknown>;
+  if (typeof obj.$ref === "string") {
+    const rest = rewriteRefs(
+      Object.fromEntries(Object.entries(obj).filter(([k]) => k !== "$ref"))
+    ) as Record<string, unknown>;
+    return {
+      ...rest,
+      $ref: (obj.$ref as string)
+        .replace("#/$defs/", "#/components/schemas/")
+        .replace("#/definitions/", "#/components/schemas/"),
+    };
+  }
+  return Object.fromEntries(
+    Object.entries(obj).map(([k, v]) => [k, rewriteRefs(v)])
+  );
+}
+
+function normalizeSchema(
+  schema: unknown,
+  components: Record<string, unknown> = {}
+): ReturnType<StandardSchemaConverter> {
+  const raw = (
+    typeof schema === "object" && schema !== null ? schema : {}
+  ) as Record<string, unknown>;
+  const normalizedComponents = Object.fromEntries(
+    Object.entries(raw.$defs ?? {}).map(([name, def]) => [
+      name,
+      rewriteRefs(def),
+    ])
+  );
+  const filtered: Record<string, unknown> = {};
+  for (const key of Object.keys(raw)) {
+    if (key !== "$defs" && key !== "definitions" && key !== "$schema") {
+      filtered[key] = raw[key];
+    }
+  }
+  return {
+    components: {
+      ...components,
+      ...normalizedComponents,
+    },
+    schema: rewriteRefs(filtered),
+  };
+}
+
 function addPrefixToPaths(paths: Record<string, unknown>, prefix: string) {
   return Object.fromEntries(
     Object.entries(paths).map(([path, value]) => [`${prefix}${path}`, value])
@@ -79,26 +131,6 @@ function mergeOpenApiSpecs(baseSpec: OpenAPIObject, ...extraSpecs: OpenAPIObject
   } as OpenAPIObject;
 }
 
-async function applyZodCleanup(
-  baseSpec: OpenAPIObject,
-  options?: NonNullable<DocsIntegrations["zod"]>
-) {
-  try {
-    const { cleanupOpenApiDoc } = await import("nestjs-zod");
-    if (typeof cleanupOpenApiDoc !== "function") {
-      return baseSpec;
-    }
-
-    if (options?.withFastify === true) {
-      return cleanupOpenApiDoc(baseSpec, { withFastify: true }) as OpenAPIObject;
-    }
-
-    return cleanupOpenApiDoc(baseSpec) as OpenAPIObject;
-  } catch {
-    return baseSpec;
-  }
-}
-
 async function applyBetterAuthSpec(
   options?: NonNullable<DocsIntegrations["betterAuth"]>
 ) {
@@ -145,7 +177,11 @@ async function applyTrpcSpec(
   }
 
   try {
-    const { generateOpenAPIDocument } = await import("@trpc/openapi");
+    const specifier = "@trpc/openapi" as string;
+    const mod: Record<string, unknown> = await import(specifier);
+    const generateOpenAPIDocument = mod.generateOpenAPIDocument as
+      | ((opts: unknown, config: unknown) => unknown)
+      | undefined;
 
     if (typeof generateOpenAPIDocument !== "function") {
       return null;
@@ -173,19 +209,6 @@ async function applyTrpcSpec(
   }
 }
 
-function createEmptyBaseSpec(options: CreateDocsOptions): OpenAPIObject {
-  return {
-    info: {
-      title: options.title ?? "NestJS API",
-      description: options.description ?? "Generated with Nest Arch",
-      version: options.version ?? "1.0.0",
-    },
-    openapi: "3.1.0",
-    paths: {},
-    tags: [],
-  } as OpenAPIObject;
-}
-
 export async function createDocs(
   app: INestApplication,
   options: CreateDocsOptions = {}
@@ -197,8 +220,29 @@ export async function createDocs(
     .setVersion(options.version ?? "1.0.0")
     .build();
 
-  let baseSpec = SwaggerModule.createDocument(app, config) as OpenAPIObject;
-  baseSpec = await applyZodCleanup(baseSpec, options.integrations?.zod);
+  const standardSchemaConverter: StandardSchemaConverter = (
+    schema,
+    { schemaType }
+  ) => {
+    const standard = (schema as Record<string, unknown> | undefined)?.[
+      "~standard"
+    ] as Record<string, unknown> | undefined;
+    const convert = standard?.jsonSchema?.[schemaType] as
+      | ((opts: { target: string }) => unknown)
+      | undefined;
+    if (!convert) {
+      return;
+    }
+    const converted = convert({ target: "openapi-3.0" });
+    if (!converted || typeof converted !== "object") {
+      return;
+    }
+    return normalizeSchema(converted);
+  };
+
+  let baseSpec = SwaggerModule.createDocument(app, config, {
+    standardSchemaConverter,
+  }) as OpenAPIObject;
 
   if (!baseSpec.paths || Object.keys(baseSpec.paths).length === 0) {
     baseSpec = {

package/dist/templates/feature/graphql/src/graphql/dto/create-todo.input.ts.hbs

@@ -0,0 +1,13 @@
+import { Field, InputType } from "@nestjs/graphql";
+
+@InputType()
+export class CreateTodoInput {
+  @Field()
+  title: string;
+
+  @Field({ nullable: true })
+  description?: string;
+
+  @Field({ defaultValue: false })
+  completed: boolean;
+}

package/dist/templates/feature/graphql/src/graphql/dto/update-todo.input.ts.hbs

@@ -0,0 +1,8 @@
+import { Field, ID, InputType, PartialType } from "@nestjs/graphql";
+import { CreateTodoInput } from "./create-todo.input.js";
+
+@InputType()
+export class UpdateTodoInput extends PartialType(CreateTodoInput) {
+  @Field(() => ID)
+  id: string;
+}

package/dist/templates/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 "../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}}
+{{#if hasTodoExample}}
+import { TodoResolver } from "./resolvers/todo.resolver.js";
+{{/if}}
+
+@Module({
+  imports: [
+    GraphQLModule.forRoot<ApolloDriverConfig>({
+      driver: ApolloDriver,
+      autoSchemaFile: join(process.cwd(), "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/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/feature/graphql/src/graphql/models/pagination.model.ts.hbs

@@ -0,0 +1,27 @@
+import { Field, Int, ObjectType } from "@nestjs/graphql";
+
+@ObjectType()
+export class PageInfo {
+  @Field()
+  hasNextPage: boolean;
+
+  @Field()
+  hasPreviousPage: boolean;
+
+  @Field({ nullable: true })
+  startCursor?: string;
+
+  @Field({ nullable: true })
+  endCursor?: string;
+}
+
+@ObjectType()
+export class Paginated<T> {
+  nodes: T[];
+
+  @Field(() => Int)
+  totalCount: number;
+
+  @Field()
+  pageInfo: PageInfo;
+}

package/dist/templates/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/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/feature/graphql/src/graphql/orm/drizzle/drizzle-graphql.module.ts.hbs

@@ -0,0 +1,42 @@
+import { Module } from "@nestjs/common";
+import { buildSchema } from "drizzle-graphql";
+{{#if isMonorepo}}
+import { db } from "@repo/db";
+{{else}}
+  {{#if hasPostgres}}
+import { drizzle } from "drizzle-orm/node-postgres";
+import { Pool } from "pg";
+  {{/if}}
+  {{#if hasMysql}}
+import { drizzle } from "drizzle-orm/mysql2";
+import mysql from "mysql2";
+  {{/if}}
+  {{#if hasSqlite}}
+import { drizzle } from "drizzle-orm/better-sqlite3";
+import Database from "better-sqlite3";
+  {{/if}}
+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 })
+  {{/if}}
+  {{#if hasMysql}}
+  drizzle(mysql.createPool(process.env.DATABASE_URL), { schema: dbSchema })
+  {{/if}}
+  {{#if hasSqlite}}
+  drizzle(new Database(process.env.DATABASE_URL), { schema: dbSchema })
+  {{/if}}
+{{/if}});
+
+@Module({
+  providers: [
+    {
+      provide: "DRIZZLE_GRAPHQL_SCHEMA",
+      useValue: schema,
+    },
+  ],
+  exports: ["DRIZZLE_GRAPHQL_SCHEMA"],
+})
+export class DrizzleGraphqlModule {}

package/dist/templates/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/feature/graphql/src/graphql/resolvers/base.resolver.ts.hbs

@@ -0,0 +1,50 @@
+import { Args, ID, Mutation, Query } from "@nestjs/graphql";
+{{#if useTypeorm}}
+import { GraphRelationBuilder } from "typeorm-relations-graphql";
+import { GraphQLResolveInfo } from "graphql";
+{{/if}}
+
+export abstract class BaseResolver<T, C, U> {
+  protected abstract get dbService(): unknown;
+
+  @Query(() => [Object])
+  async findAll({{#if useTypeorm}}info: GraphQLResolveInfo{{/if}}): Promise<T[]> {
+    {{#if useTypeorm}}
+    const builder = new GraphRelationBuilder(this.dbService.getDataSource());
+    const relations = builder.buildForQuery(this.getEntityClass(), info);
+    return this.dbService.getRepository(this.getEntityClass()).find({ relations });
+    {{else}}
+    return [];
+    {{/if}}
+  }
+
+  @Mutation(() => Object)
+  async create(
+    @Args("input") input: C{{#if useTypeorm}}, info: GraphQLResolveInfo{{/if}}
+  ): Promise<T> {
+    {{#if useTypeorm}}
+    const entity = this.dbService.getRepository(this.getEntityClass()).create(input);
+    const saved = await this.dbService.getRepository(this.getEntityClass()).save(entity);
+    const builder = new GraphRelationBuilder(this.dbService.getDataSource());
+    const relations = builder.buildForQuery(this.getEntityClass(), info);
+    return this.dbService.getRepository(this.getEntityClass()).findOneOrFail({
+      where: { id: saved.id },
+      relations,
+    });
+    {{else}}
+    return input as unknown as T;
+    {{/if}}
+  }
+
+  @Mutation(() => Boolean)
+  async delete(@Args("id", { type: () => ID }) id: string): Promise<boolean> {
+    {{#if useTypeorm}}
+    const result = await this.dbService.getRepository(this.getEntityClass()).delete(id);
+    return (result.affected ?? 0) > 0;
+    {{else}}
+    return true;
+    {{/if}}
+  }
+
+  protected abstract getEntityClass(): new () => T;
+}