@exanderal/stackcraft 0.1.2 → 0.2.1

package/templates/api-nestjs-graphql/src/app.module.ts

@@ -0,0 +1,21 @@
+import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { GraphQLModule } from '@nestjs/graphql';
+import { join } from 'node:path';
+import { DatabaseModule } from './modules/database/database.module';
+import { HealthModule } from './modules/health/health.module';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({ isGlobal: true }),
+    GraphQLModule.forRoot<ApolloDriverConfig>({
+      driver: ApolloDriver,
+      autoSchemaFile: join(process.cwd(), 'src/schema.gql'),
+      sortSchema: true,
+    }),
+    DatabaseModule,
+    HealthModule,
+  ],
+})
+export class AppModule {}

package/templates/api-nestjs-graphql/src/common/entities/base.entity.ts

@@ -0,0 +1,21 @@
+import { Field, ID, ObjectType } from '@nestjs/graphql';
+import {
+  CreateDateColumn,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+
+@ObjectType({ isAbstract: true })
+export abstract class BaseEntity {
+  @Field(() => ID)
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @Field()
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @Field()
+  @UpdateDateColumn()
+  updatedAt: Date;
+}

package/templates/api-nestjs-graphql/src/common/repositories/entity.repository.ts

@@ -0,0 +1,21 @@
+import { DeepPartial } from 'typeorm';
+import { BaseEntity } from '../entities/base.entity';
+import { ReadonlyEntityRepository } from './readonly-entity.repository';
+
+export abstract class EntityRepository<
+  T extends BaseEntity,
+> extends ReadonlyEntityRepository<T> {
+  async create(data: DeepPartial<T>): Promise<T> {
+    const entity = this.repo.create(data);
+    return this.repo.save(entity);
+  }
+
+  async update(id: string, data: DeepPartial<T>): Promise<T> {
+    await this.repo.update(id, data as any);
+    return this.findById(id) as Promise<T>;
+  }
+
+  async remove(id: string): Promise<void> {
+    await this.repo.delete(id);
+  }
+}

package/templates/api-nestjs-graphql/src/common/repositories/readonly-entity.repository.ts

@@ -0,0 +1,22 @@
+import { FindManyOptions, FindOptionsWhere, In, Repository } from 'typeorm';
+import { BaseEntity } from '../entities/base.entity';
+
+export abstract class ReadonlyEntityRepository<T extends BaseEntity> {
+  constructor(protected readonly repo: Repository<T>) {}
+
+  findAll(options?: FindManyOptions<T>): Promise<T[]> {
+    return this.repo.find(options);
+  }
+
+  findByIds(ids: string[]): Promise<T[]> {
+    return this.repo.findBy({ id: In(ids) } as FindOptionsWhere<T>);
+  }
+
+  findById(id: string): Promise<T | null> {
+    return this.repo.findOneBy({ id } as FindOptionsWhere<T>);
+  }
+
+  findOne(where: FindOptionsWhere<T>): Promise<T | null> {
+    return this.repo.findOneBy(where);
+  }
+}

package/templates/api-nestjs-graphql/src/common/services/entity.service.ts

@@ -0,0 +1,24 @@
+import { DeepPartial } from 'typeorm';
+import { BaseEntity } from '../entities/base.entity';
+import { EntityRepository } from '../repositories/entity.repository';
+import { ReadonlyEntityService } from './readonly-entity.service';
+
+export abstract class EntityService<
+  T extends BaseEntity,
+> extends ReadonlyEntityService<T> {
+  constructor(protected readonly repository: EntityRepository<T>) {
+    super(repository);
+  }
+
+  create(data: DeepPartial<T>): Promise<T> {
+    return this.repository.create(data);
+  }
+
+  update(id: string, data: DeepPartial<T>): Promise<T> {
+    return this.repository.update(id, data);
+  }
+
+  remove(id: string): Promise<void> {
+    return this.repository.remove(id);
+  }
+}

package/templates/api-nestjs-graphql/src/common/services/readonly-entity.service.ts

@@ -0,0 +1,23 @@
+import { FindManyOptions, FindOptionsWhere } from 'typeorm';
+import { BaseEntity } from '../entities/base.entity';
+import { ReadonlyEntityRepository } from '../repositories/readonly-entity.repository';
+
+export abstract class ReadonlyEntityService<T extends BaseEntity> {
+  constructor(protected readonly repository: ReadonlyEntityRepository<T>) {}
+
+  findAll(options?: FindManyOptions<T>): Promise<T[]> {
+    return this.repository.findAll(options);
+  }
+
+  findByIds(ids: string[]): Promise<T[]> {
+    return this.repository.findByIds(ids);
+  }
+
+  findById(id: string): Promise<T | null> {
+    return this.repository.findById(id);
+  }
+
+  findOne(where: FindOptionsWhere<T>): Promise<T | null> {
+    return this.repository.findOne(where);
+  }
+}

package/templates/api-nestjs-graphql/src/main.ts

@@ -0,0 +1,8 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(process.env.PORT ?? 3000);
+}
+bootstrap();

package/templates/api-nestjs-graphql/src/modules/database/database.module.ts

@@ -0,0 +1,18 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+
+@Module({
+  imports: [
+    TypeOrmModule.forRoot({
+      type: '{{dbType}}' as 'postgres' | 'mysql',
+      host: process.env.DB_HOST ?? 'localhost',
+      port: parseInt(process.env.DB_PORT ?? '{{dbPort}}', 10),
+      username: process.env.DB_USER ?? 'postgres',
+      password: process.env.DB_PASSWORD ?? '',
+      database: process.env.DB_NAME ?? '{{projectName}}',
+      entities: [],
+      synchronize: process.env.NODE_ENV !== 'production',
+    }),
+  ],
+})
+export class DatabaseModule {}

package/templates/api-nestjs-graphql/src/modules/health/__tests__/health.controller.spec.ts

@@ -0,0 +1,20 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { HealthController } from './health.controller';
+import { HealthService } from './health.service';
+
+describe('HealthController', () => {
+  let controller: HealthController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [HealthController],
+      providers: [HealthService],
+    }).compile();
+
+    controller = module.get<HealthController>(HealthController);
+  });
+
+  it('returns ok status', () => {
+    expect(controller.check()).toEqual({ status: 'ok' });
+  });
+});

package/templates/api-nestjs-graphql/src/modules/health/__tests__/health.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { HealthService } from './health.service';
+
+describe('HealthService', () => {
+  let service: HealthService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [HealthService],
+    }).compile();
+
+    service = module.get<HealthService>(HealthService);
+  });
+
+  it('returns ok status', () => {
+    expect(service.check()).toEqual({ status: 'ok' });
+  });
+});

package/templates/api-nestjs-graphql/src/modules/health/health.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { HealthService } from './health.service';
+
+@Controller('health')
+export class HealthController {
+  constructor(private readonly healthService: HealthService) {}
+
+  @Get()
+  check() {
+    return this.healthService.check();
+  }
+}

package/templates/api-nestjs-graphql/src/modules/health/health.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { HealthController } from './health.controller';
+import { HealthService } from './health.service';
+
+@Module({
+  controllers: [HealthController],
+  providers: [HealthService],
+})
+export class HealthModule {}

package/templates/api-nestjs-graphql/src/modules/health/health.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class HealthService {
+  check() {
+    return { status: 'ok' };
+  }
+}

package/templates/api-nestjs-graphql/test/app.e2e-spec.ts

@@ -0,0 +1,29 @@
+import { INestApplication } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+import * as request from 'supertest';
+import { App } from 'supertest/types';
+import { AppModule } from './../src/app.module';
+
+describe('App (e2e)', () => {
+  let app: INestApplication<App>;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  afterEach(async () => {
+    await app.close();
+  });
+
+  it('/health (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/health')
+      .expect(200)
+      .expect({ status: 'ok' });
+  });
+});

package/templates/api-nestjs-graphql/test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

package/templates/api-nestjs-graphql/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

package/templates/api-nestjs-graphql/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2023",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "noFallthroughCasesInSwitch": false
+  }
+}

package/templates/api-nestjs-rest/package.json

@@ -25,6 +25,7 @@
     "@nestjs/config": "^3.0.0",
     "@nestjs/core": "^11.0.1",
     "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/swagger": "^11.0.0",
     "@nestjs/typeorm": "^10.0.0",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",

package/templates/api-nestjs-rest/src/main.ts

@@ -1,8 +1,19 @@
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 import { NestFactory } from '@nestjs/core';
+import { writeFileSync } from 'node:fs';
 import { AppModule } from './app.module';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+
+  const config = new DocumentBuilder()
+    .setTitle('{{projectName}}')
+    .setVersion('1.0')
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('api', app, document);
+  writeFileSync('./swagger.json', JSON.stringify(document, null, 2));
+
   await app.listen(process.env.PORT ?? 3000);
 }
 bootstrap();

package/templates/base/package.json

@@ -7,7 +7,11 @@
     "build": "nx run-many -t build",
     "test": "nx run-many -t test",
     "lint": "nx run-many -t lint",
-    "generate:module": "nx g @local/generators:module"
+    "generate:module": "nx g @local/generators:module",
+    "generate:resolver": "nx g @local/generators:resolver",
+    "generate:controller": "nx g @local/generators:controller",
+    "codegen": "nx run types:codegen",
+    "codegen:watch": "nx run types:codegen:watch"
   },
   "devDependencies": {
     "@nx/devkit": "^20.0.0",

package/templates/base/packages/types/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@local/types",
+  "version": "0.0.1",
+  "private": true,
+  "exports": {
+    "./rest": "./src/rest/index.ts",
+    "./graphql": "./src/graphql/index.ts"
+  },
+  "devDependencies": {}
+}

package/templates/base/packages/types/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "target": "ES2022",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  }
+}

package/templates/base/tools/generators/controller/index.js

@@ -0,0 +1,22 @@
+const { formatFiles, generateFiles, names } = require('@nx/devkit');
+const { execSync } = require('node:child_process');
+const { join } = require('node:path');
+
+module.exports = async function (tree, options) {
+  const n = names(options.name);
+  const controllerPath = `apps/backend/src/api/${n.fileName}`;
+
+  generateFiles(tree, join(__dirname, 'files'), controllerPath, { ...n, tmpl: '' });
+
+  await formatFiles(tree);
+
+  console.log(`\n✓ Controller created at ${controllerPath}/`);
+  console.log(`  → Import ${n.className}Module and register ${n.className}Controller in your module\n`);
+
+  return () => {
+    execSync(`npx prettier --write ${controllerPath}`, {
+      cwd: tree.root,
+      stdio: 'inherit',
+    });
+  };
+};

package/templates/base/tools/generators/controller/schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "id": "controller",
+  "title": "Create a REST controller",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Module name to generate a controller for (e.g. trainer)",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      }
+    }
+  },
+  "required": ["name"]
+}

package/templates/base/tools/generators/generators.json

@@ -3,7 +3,17 @@
     "module": {
       "factory": "./module/index",
       "schema": "./module/schema.json",
-      "description": "Create a NestJS module"
+      "description": "Create a NestJS domain module (model, repository, service)"
+    },
+    "resolver": {
+      "factory": "./resolver/index",
+      "schema": "./resolver/schema.json",
+      "description": "Create a GraphQL resolver in src/resolvers/"
+    },
+    "controller": {
+      "factory": "./controller/index",
+      "schema": "./controller/schema.json",
+      "description": "Create a REST controller in src/api/"
     }
   }
 }

package/templates/base/tools/generators/module/graphql-files/__fileName__.model.ts__tmpl__

@@ -0,0 +1,11 @@
+import { ObjectType } from '@nestjs/graphql';
+import { Entity } from 'typeorm';
+import { BaseEntity } from '../../common/entities/base.entity';
+
+@ObjectType()
+@Entity('<%= fileName %>s')
+export class <%= className %>Model extends BaseEntity {
+  // @Field()
+  // @Column()
+  // name: string;
+}

package/templates/base/tools/generators/module/index.js

@@ -6,20 +6,10 @@ module.exports = async function (tree, options) {
   const n = names(options.name);
   const modulePath = `apps/backend/src/modules/${n.fileName}`;
 
-  generateFiles(
-    tree,
-    join(__dirname, 'files'),
-    modulePath,
-    { ...n, tmpl: '' },
-  );
+  generateFiles(tree, join(__dirname, 'files'), modulePath, { ...n, tmpl: '' });
 
-  if (options.crud) {
-    generateFiles(
-      tree,
-      join(__dirname, 'crud-files'),
-      `apps/backend/src/api/${n.fileName}`,
-      { ...n, tmpl: '' },
-    );
+  if (options.graphql) {
+    generateFiles(tree, join(__dirname, 'graphql-files'), modulePath, { ...n, tmpl: '' });
   }
 
   await formatFiles(tree);
@@ -27,16 +17,8 @@ module.exports = async function (tree, options) {
   console.log(`\n✓ Module created at ${modulePath}/`);
   console.log(`  → Import ${n.className}Module in app.module.ts\n`);
 
-  if (options.crud) {
-    console.log(`✓ Controller created at apps/backend/src/api/${n.fileName}/`);
-    console.log(`  → Add ${n.className}Controller to a module and import ${n.className}Module there\n`);
-  }
-
   return () => {
-    const targets = [modulePath];
-    if (options.crud) targets.push(`apps/backend/src/api/${n.fileName}`);
-
-    execSync(`npx prettier --write ${targets.join(' ')}`, {
+    execSync(`npx prettier --write ${modulePath}`, {
       cwd: tree.root,
       stdio: 'inherit',
     });

package/templates/base/tools/generators/module/schema.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/schema",
   "cli": "nx",
   "id": "module",
-  "title": "Create a NestJS module",
+  "title": "Create a NestJS domain module",
   "type": "object",
   "properties": {
     "name": {
@@ -13,11 +13,10 @@
         "index": 0
       }
     },
-    "crud": {
+    "graphql": {
       "type": "boolean",
-      "description": "Generate a CRUD controller in src/api/<name>/",
-      "default": false,
-      "x-prompt": "Generate a CRUD controller?"
+      "description": "Add @ObjectType() to the model (required for GraphQL resolvers)",
+      "default": false
     }
   },
   "required": ["name"]

package/templates/base/tools/generators/resolver/files/__fileName__.resolver.ts__tmpl__

@@ -0,0 +1,28 @@
+import {
+  Args,
+  Mutation,
+  Query,
+  Resolver,
+} from '@nestjs/graphql';
+import { <%= className %>Model } from '../../modules/<%= fileName %>/<%= fileName %>.model';
+import { <%= className %>Service } from '../../modules/<%= fileName %>/<%= fileName %>.service';
+
+@Resolver(() => <%= className %>Model)
+export class <%= className %>Resolver {
+  constructor(private readonly service: <%= className %>Service) {}
+
+  @Query(() => [<%= className %>Model])
+  <%= propertyName %>s() {
+    return this.service.findAll();
+  }
+
+  @Query(() => <%= className %>Model, { nullable: true })
+  <%= propertyName %>(@Args('id') id: string) {
+    return this.service.findById(id);
+  }
+
+  @Mutation(() => Boolean)
+  remove<%= className %>(@Args('id') id: string) {
+    return this.service.remove(id).then(() => true);
+  }
+}

package/templates/base/tools/generators/resolver/index.js

@@ -0,0 +1,22 @@
+const { formatFiles, generateFiles, names } = require('@nx/devkit');
+const { execSync } = require('node:child_process');
+const { join } = require('node:path');
+
+module.exports = async function (tree, options) {
+  const n = names(options.name);
+  const resolverPath = `apps/backend/src/resolvers/${n.fileName}`;
+
+  generateFiles(tree, join(__dirname, 'files'), resolverPath, { ...n, tmpl: '' });
+
+  await formatFiles(tree);
+
+  console.log(`\n✓ Resolver created at ${resolverPath}/`);
+  console.log(`  → Import ${n.className}Module and register ${n.className}Resolver in your module\n`);
+
+  return () => {
+    execSync(`npx prettier --write ${resolverPath}`, {
+      cwd: tree.root,
+      stdio: 'inherit',
+    });
+  };
+};

package/templates/base/tools/generators/resolver/schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "id": "resolver",
+  "title": "Create a GraphQL resolver",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Module name to generate a resolver for (e.g. trainer)",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      }
+    }
+  },
+  "required": ["name"]
+}

package/templates/types-graphql/codegen.ts

@@ -0,0 +1,17 @@
+import type { CodegenConfig } from '@graphql-codegen/cli';
+
+const config: CodegenConfig = {
+  schema: '../../apps/backend/src/schema.gql',
+  documents: ['../../apps/web/src/**/*.graphql'],
+  generates: {
+    './src/graphql/index.ts': {
+      plugins: [
+        'typescript',
+        'typescript-operations',
+        'typescript-react-apollo',
+      ],
+    },
+  },
+};
+
+export default config;

package/templates/types-graphql/project.json

@@ -0,0 +1,19 @@
+{
+  "name": "types",
+  "targets": {
+    "codegen": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "graphql-codegen --config codegen.ts",
+        "cwd": "{projectRoot}"
+      }
+    },
+    "codegen:watch": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "graphql-codegen --config codegen.ts --watch",
+        "cwd": "{projectRoot}"
+      }
+    }
+  }
+}

package/templates/types-rest/openapi-ts.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from '@hey-api/openapi-ts';
+
+export default defineConfig({
+  input: '../../apps/backend/swagger.json',
+  output: {
+    path: './src/rest',
+    format: 'prettier',
+  },
+  plugins: ['@hey-api/typescript'],
+});