@exanderal/stackcraft 0.1.1 → 0.2.0

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

@@ -1,5 +1,5 @@
 {
-  "name": "{{projectName}}-api",
+  "name": "{{projectName}}-backend",
   "version": "0.0.1",
   "description": "",
   "author": "",
@@ -22,10 +22,13 @@
   },
   "dependencies": {
     "@nestjs/common": "^11.0.1",
+    "@nestjs/config": "^3.0.0",
     "@nestjs/core": "^11.0.1",
     "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/typeorm": "^10.0.0",
     "reflect-metadata": "^0.2.2",
-    "rxjs": "^7.8.1"
+    "rxjs": "^7.8.1",
+    "typeorm": "^0.3.0"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.2.0",

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

@@ -1,5 +1,5 @@
 {
-  "name": "api",
+  "name": "backend",
   "targets": {
     "dev": {
       "executor": "nx:run-commands",

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

@@ -1,10 +1,13 @@
 import { Module } from '@nestjs/common';
-import { AppController } from './app.controller';
-import { AppService } from './app.service';
+import { ConfigModule } from '@nestjs/config';
+import { DatabaseModule } from './modules/database/database.module';
+import { HealthModule } from './modules/health/health.module';
 
 @Module({
-  imports: [],
-  controllers: [AppController],
-  providers: [AppService],
+  imports: [
+    ConfigModule.forRoot({ isGlobal: true }),
+    DatabaseModule,
+    HealthModule,
+  ],
 })
 export class AppModule {}

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

@@ -0,0 +1,16 @@
+import {
+  CreateDateColumn,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+
+export abstract class BaseEntity {
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @UpdateDateColumn()
+  updatedAt: Date;
+}

package/templates/api-nestjs-rest/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-rest/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-rest/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-rest/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-rest/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-rest/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-rest/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-rest/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-rest/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-rest/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-rest/test/app.e2e-spec.ts

@@ -1,10 +1,10 @@
-import { Test, TestingModule } from '@nestjs/testing';
 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('AppController (e2e)', () => {
+describe('App (e2e)', () => {
   let app: INestApplication<App>;
 
   beforeEach(async () => {
@@ -16,10 +16,14 @@ describe('AppController (e2e)', () => {
     await app.init();
   });
 
-  it('/ (GET)', () => {
+  afterEach(async () => {
+    await app.close();
+  });
+
+  it('/health (GET)', () => {
     return request(app.getHttpServer())
-      .get('/')
+      .get('/health')
       .expect(200)
-      .expect('Hello World!');
+      .expect({ status: 'ok' });
   });
 });

package/templates/base/package.json

@@ -6,9 +6,13 @@
     "dev": "nx run-many -t dev",
     "build": "nx run-many -t build",
     "test": "nx run-many -t test",
-    "lint": "nx run-many -t lint"
+    "lint": "nx run-many -t lint",
+    "generate:module": "nx g @local/generators:module",
+    "generate:resolver": "nx g @local/generators:resolver",
+    "generate:controller": "nx g @local/generators:controller"
   },
   "devDependencies": {
+    "@nx/devkit": "^20.0.0",
     "nx": "^20.0.0"
   }
 }

package/templates/base/pnpm-workspace.yaml

@@ -1,3 +1,4 @@
 packages:
   - 'apps/*'
   - 'packages/*' # shared code: graphql types, ui components, etc.
+  - 'tools/generators'

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

@@ -0,0 +1,36 @@
+import {
+  Controller,
+  Delete,
+  Get,
+  Param,
+  ParseUUIDPipe,
+  Query,
+} from '@nestjs/common';
+import { FindManyOptions } from 'typeorm';
+import { <%= className %>Model } from '../../modules/<%= fileName %>/<%= fileName %>.model';
+import { <%= className %>Service } from '../../modules/<%= fileName %>/<%= fileName %>.service';
+
+@Controller('<%= fileName %>s')
+export class <%= className %>Controller {
+  constructor(private readonly service: <%= className %>Service) {}
+
+  @Get()
+  findAll(@Query() query: FindManyOptions<<%= className %>Model>) {
+    return this.service.findAll(query);
+  }
+
+  @Get('by-ids')
+  findByIds(@Query('ids') ids: string) {
+    return this.service.findByIds(ids.split(','));
+  }
+
+  @Get(':id')
+  findById(@Param('id', ParseUUIDPipe) id: string) {
+    return this.service.findById(id);
+  }
+
+  @Delete(':id')
+  remove(@Param('id', ParseUUIDPipe) id: string) {
+    return this.service.remove(id);
+  }
+}

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

@@ -0,0 +1,19 @@
+{
+  "generators": {
+    "module": {
+      "factory": "./module/index",
+      "schema": "./module/schema.json",
+      "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/files/__fileName__.model.ts__tmpl__

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

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

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { <%= className %>Model } from './<%= fileName %>.model';
+import { <%= className %>Repository } from './<%= fileName %>.repository';
+import { <%= className %>Service } from './<%= fileName %>.service';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([<%= className %>Model])],
+  providers: [<%= className %>Service, <%= className %>Repository],
+  exports: [<%= className %>Service, <%= className %>Repository],
+})
+export class <%= className %>Module {}

package/templates/base/tools/generators/module/files/__fileName__.repository.ts__tmpl__

@@ -0,0 +1,15 @@
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+import { Repository } from 'typeorm';
+import { EntityRepository } from '../../common/repositories/entity.repository';
+import { <%= className %>Model } from './<%= fileName %>.model';
+
+@Injectable()
+export class <%= className %>Repository extends EntityRepository<<%= className %>Model> {
+  constructor(
+    @InjectRepository(<%= className %>Model)
+    repo: Repository<<%= className %>Model>,
+  ) {
+    super(repo);
+  }
+}

package/templates/base/tools/generators/module/files/__fileName__.service.ts__tmpl__

@@ -0,0 +1,11 @@
+import { Injectable } from '@nestjs/common';
+import { EntityService } from '../../common/services/entity.service';
+import { <%= className %>Model } from './<%= fileName %>.model';
+import { <%= className %>Repository } from './<%= fileName %>.repository';
+
+@Injectable()
+export class <%= className %>Service extends EntityService<<%= className %>Model> {
+  constructor(repository: <%= className %>Repository) {
+    super(repository);
+  }
+}