@exanderal/stackcraft 0.4.2 → 0.5.0

package/templates/orm-kysely/src/database/utils/columns.ts

@@ -0,0 +1,32 @@
+import { sql, CreateTableBuilder } from 'kysely';
+
+export function withUuid<T extends string, C extends string>(
+  builder: CreateTableBuilder<T, C>,
+  dialect: 'postgres' | 'mysql' = 'postgres',
+) {
+  const defaultFn =
+    dialect === 'mysql' ? sql`(UUID())` : sql`gen_random_uuid()`;
+  return builder.addColumn('id', 'uuid', (col) =>
+    col.primaryKey().defaultTo(defaultFn),
+  );
+}
+
+export function withTimestamps<T extends string, C extends string>(
+  builder: CreateTableBuilder<T, C>,
+) {
+  return builder
+    .addColumn('created_at', 'timestamptz', (col) =>
+      col.notNull().defaultTo(sql`now()`),
+    )
+    .addColumn('updated_at', 'timestamptz', (col) =>
+      col.notNull().defaultTo(sql`now()`),
+    );
+}
+
+// Shorthand: uuid primary key + timestamps
+export function withDefaults<T extends string, C extends string>(
+  builder: CreateTableBuilder<T, C>,
+  dialect: 'postgres' | 'mysql' = 'postgres',
+) {
+  return withTimestamps(withUuid(builder, dialect));
+}

package/templates/orm-kysely/src/database/utils/index.ts

@@ -0,0 +1,3 @@
+export * from './columns';
+export * from './indexes';
+export * from './tables';

package/templates/orm-kysely/src/database/utils/indexes.ts

@@ -0,0 +1,20 @@
+import { Kysely } from 'kysely';
+
+export async function createIndex(
+  db: Kysely<any>,
+  table: string,
+  columns: string | string[],
+  opts?: { unique?: boolean; name?: string },
+) {
+  const cols = Array.isArray(columns) ? columns : [columns];
+  const name = opts?.name ?? `idx_${table}_${cols.join('_')}`;
+  let b = db.schema.createIndex(name).on(table).columns(cols);
+  if (opts?.unique) b = (b as any).unique();
+  await b.execute();
+}
+
+export const createUniqueIndex = (
+  db: Kysely<any>,
+  table: string,
+  columns: string | string[],
+) => createIndex(db, table, columns, { unique: true });

package/templates/orm-kysely/src/database/utils/tables.ts

@@ -0,0 +1,7 @@
+import { Kysely } from 'kysely';
+
+export const createTable = (db: Kysely<any>, name: string) =>
+  db.schema.createTable(name);
+
+export const dropTable = (db: Kysely<any>, name: string) =>
+  db.schema.dropTable(name).ifExists().execute();

package/templates/orm-kysely/src/modules/database/database.module.ts

@@ -0,0 +1,9 @@
+import { Global, Module } from '@nestjs/common';
+import { KyselyService } from './kysely.service';
+
+@Global()
+@Module({
+  providers: [KyselyService],
+  exports: [KyselyService],
+})
+export class DatabaseModule {}

package/templates/orm-kysely/tools/generators/module/files/__fileName__.model.ts__tmpl__

@@ -0,0 +1,16 @@
+// Define this table in src/database/database.types.ts:
+//
+// export interface <%= className %>sTable {
+//   id: Generated<string>
+//   created_at: Generated<Date>
+//   updated_at: Generated<Date>
+// }
+//
+// Then add to Database interface:
+//   <%= fileName %>s: <%= className %>sTable
+
+export interface <%= className %> {
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
+}

package/templates/orm-kysely/tools/generators/module/files/__fileName__.module.ts__tmpl__

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

package/templates/orm-kysely/tools/generators/module/files/__fileName__.repository.ts__tmpl__

@@ -0,0 +1,26 @@
+import { Injectable } from '@nestjs/common';
+import { EntityRepository } from '../../common/repositories/entity.repository';
+import { KyselyService } from '../../modules/database/kysely.service';
+import type { <%= className %> } from './<%= fileName %>.model';
+
+// Add properties to enable filtering, e.g.:
+// export type <%= className %>Filters = { id?: string }
+export type <%= className %>Filters = Record<string, never>
+
+@Injectable()
+export class <%= className %>Repository extends EntityRepository<<%= className %>, <%= className %>Filters> {
+  protected table = '<%= fileName %>s';
+
+  constructor(kyselyService: KyselyService) {
+    super(kyselyService.db);
+  }
+
+  // protected filters = {
+  //   id: where('<%= fileName %>s.id'),
+  // };
+
+  // protected override queryable() {
+  //   return super.queryable()
+  //     .innerJoin('other_table', 'other_table.id', '<%= fileName %>s.other_id')
+  // }
+}

package/templates/orm-kysely/tools/generators/module/files/__fileName__.service.ts__tmpl__

@@ -0,0 +1,28 @@
+import { Injectable } from '@nestjs/common';
+import type { <%= className %> } from './<%= fileName %>.model';
+import { <%= className %>Repository } from './<%= fileName %>.repository';
+
+@Injectable()
+export class <%= className %>Service {
+  constructor(private readonly repository: <%= className %>Repository) {}
+
+  findAll() {
+    return this.repository.findAll();
+  }
+
+  findById(id: string) {
+    return this.repository.findById(id);
+  }
+
+  create(data: Omit<<%= className %>, 'id' | 'createdAt' | 'updatedAt'>) {
+    return this.repository.create(data);
+  }
+
+  update(id: string, data: Partial<Omit<<%= className %>, 'id' | 'createdAt' | 'updatedAt'>>) {
+    return this.repository.update(id, data);
+  }
+
+  remove(id: string) {
+    return this.repository.remove(id);
+  }
+}

package/templates/orm-kysely/tools/generators/module/files/__tests__/__fileName__.integration.spec.ts__tmpl__

@@ -0,0 +1,23 @@
+import { Test } from '@nestjs/testing';
+import { KyselyService } from '../../modules/database/kysely.service';
+import { <%= className %>Module } from '../<%= fileName %>.module';
+import { <%= className %>Service } from '../<%= fileName %>.service';
+
+describe('<%= className %>Service', () => {
+  let service: <%= className %>Service;
+
+  beforeAll(async () => {
+    const module = await Test.createTestingModule({
+      imports: [<%= className %>Module],
+    })
+      .overrideProvider(KyselyService)
+      .useValue({ db: {} })
+      .compile();
+
+    service = module.get(<%= className %>Service);
+  });
+
+  it('is defined', () => {
+    expect(service).toBeDefined();
+  });
+});

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

@@ -0,0 +1,24 @@
+import { Field, ID, ObjectType } from '@nestjs/graphql';
+
+// Define this table in src/database/database.types.ts:
+//
+// export interface <%= className %>sTable {
+//   id: Generated<string>
+//   created_at: Generated<Date>
+//   updated_at: Generated<Date>
+// }
+//
+// Then add to Database interface:
+//   <%= fileName %>s: <%= className %>sTable
+
+@ObjectType()
+export class <%= className %> {
+  @Field(() => ID)
+  id: string;
+
+  @Field(() => String)
+  createdAt: Date;
+
+  @Field(() => String)
+  updatedAt: Date;
+}

package/templates/orm-prisma/prisma/schema.prisma

@@ -0,0 +1,8 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "{{dbProvider}}"
+  url      = env("DATABASE_URL")
+}

package/templates/orm-prisma/prisma/seeds/seed.ts

@@ -0,0 +1,16 @@
+import { PrismaClient } from '@prisma/client';
+
+const prisma = new PrismaClient();
+
+async function main() {
+  // Example:
+  // await prisma.user.create({ data: { email: 'admin@example.com', name: 'Admin' } });
+  console.log('Seed complete.');
+}
+
+main()
+  .catch((e) => {
+    console.error(e);
+    process.exit(1);
+  })
+  .finally(() => prisma.$disconnect());

package/templates/orm-prisma/src/modules/database/database.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { PrismaModule } from '../prisma/prisma.module';
+
+@Module({
+  imports: [PrismaModule],
+  exports: [PrismaModule],
+})
+export class DatabaseModule {}

package/templates/orm-prisma/src/modules/prisma/prisma.module.ts

@@ -0,0 +1,9 @@
+import { Global, Module } from '@nestjs/common';
+import { PrismaService } from './prisma.service';
+
+@Global()
+@Module({
+  providers: [PrismaService],
+  exports: [PrismaService],
+})
+export class PrismaModule {}

package/templates/orm-prisma/src/modules/prisma/prisma.service.ts

@@ -0,0 +1,9 @@
+import { Injectable, OnModuleInit } from '@nestjs/common';
+import { PrismaClient } from '@prisma/client';
+
+@Injectable()
+export class PrismaService extends PrismaClient implements OnModuleInit {
+  async onModuleInit() {
+    await this.$connect();
+  }
+}

package/templates/orm-prisma/tools/generators/module/files/__fileName__.model.ts__tmpl__

@@ -0,0 +1,15 @@
+// Add this model to prisma/schema.prisma:
+//
+// model <%= className %> {
+//   id        String   @id @default(cuid())
+//   createdAt DateTime @default(now())
+//   updatedAt DateTime @updatedAt
+// }
+//
+// Then run: pnpm migration:run
+
+export type <%= className %> = {
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
+};

package/templates/orm-prisma/tools/generators/module/files/__fileName__.module.ts__tmpl__

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

package/templates/orm-prisma/tools/generators/module/files/__fileName__.repository.ts__tmpl__

@@ -0,0 +1,28 @@
+import { Injectable } from '@nestjs/common';
+import { PrismaService } from '../../modules/prisma/prisma.service';
+import type { <%= className %> } from './<%= fileName %>.model';
+
+@Injectable()
+export class <%= className %>Repository {
+  constructor(private readonly prisma: PrismaService) {}
+
+  findAll() {
+    return this.prisma.<%= fileName %>.findMany();
+  }
+
+  findById(id: string) {
+    return this.prisma.<%= fileName %>.findUnique({ where: { id } });
+  }
+
+  create(data: Omit<<%= className %>, 'id' | 'createdAt' | 'updatedAt'>) {
+    return this.prisma.<%= fileName %>.create({ data });
+  }
+
+  update(id: string, data: Partial<Omit<<%= className %>, 'id' | 'createdAt' | 'updatedAt'>>) {
+    return this.prisma.<%= fileName %>.update({ where: { id }, data });
+  }
+
+  remove(id: string) {
+    return this.prisma.<%= fileName %>.delete({ where: { id } });
+  }
+}

package/templates/orm-prisma/tools/generators/module/files/__fileName__.service.ts__tmpl__

@@ -0,0 +1,28 @@
+import { Injectable } from '@nestjs/common';
+import type { <%= className %> } from './<%= fileName %>.model';
+import { <%= className %>Repository } from './<%= fileName %>.repository';
+
+@Injectable()
+export class <%= className %>Service {
+  constructor(private readonly repository: <%= className %>Repository) {}
+
+  findAll(): Promise<<%= className %>[]> {
+    return this.repository.findAll();
+  }
+
+  findById(id: string): Promise<<%= className %> | null> {
+    return this.repository.findById(id);
+  }
+
+  create(data: Omit<<%= className %>, 'id' | 'createdAt' | 'updatedAt'>): Promise<<%= className %>> {
+    return this.repository.create(data);
+  }
+
+  update(id: string, data: Partial<Omit<<%= className %>, 'id' | 'createdAt' | 'updatedAt'>>): Promise<<%= className %>> {
+    return this.repository.update(id, data);
+  }
+
+  remove(id: string): Promise<<%= className %>> {
+    return this.repository.remove(id);
+  }
+}

package/templates/orm-prisma/tools/generators/module/files/__tests__/__fileName__.integration.spec.ts__tmpl__

@@ -0,0 +1,23 @@
+import { Test } from '@nestjs/testing';
+import { PrismaService } from '../../modules/prisma/prisma.service';
+import { <%= className %>Module } from '../<%= fileName %>.module';
+import { <%= className %>Service } from '../<%= fileName %>.service';
+
+describe('<%= className %>Service', () => {
+  let service: <%= className %>Service;
+
+  beforeAll(async () => {
+    const module = await Test.createTestingModule({
+      imports: [<%= className %>Module],
+    })
+      .overrideProvider(PrismaService)
+      .useValue({})
+      .compile();
+
+    service = module.get(<%= className %>Service);
+  });
+
+  it('is defined', () => {
+    expect(service).toBeDefined();
+  });
+});

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

@@ -0,0 +1,23 @@
+import { Field, ID, ObjectType } from '@nestjs/graphql';
+
+// Add this model to prisma/schema.prisma:
+//
+// model <%= className %> {
+//   id        String   @id @default(cuid())
+//   createdAt DateTime @default(now())
+//   updatedAt DateTime @updatedAt
+// }
+//
+// Then run: pnpm migration:run
+
+@ObjectType()
+export class <%= className %> {
+  @Field(() => ID)
+  id: string;
+
+  @Field(() => String)
+  createdAt: Date;
+
+  @Field(() => String)
+  updatedAt: Date;
+}

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

@@ -1,21 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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/modules/database/database.module.ts

@@ -1,18 +0,0 @@
-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/common/entities/base.entity.ts

@@ -1,16 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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);
-  }
-}