nestjs-typeorm3-kit 0.1.3 → 0.1.5

package/README.md

@@ -104,6 +104,146 @@ import { DefRepositoryModule } from "nestjs-typeorm3-kit";
 export class PrimaryRepoModule {}
 ```
 
+#### Use @DefTransaction
+
+```typescript
+import { Injectable } from "@nestjs/common";
+import { DefTransaction, InjectRepo } from "nestjs-typeorm3-kit";
+import { PhotoRepo } from "~/domains/primary/photo/photo.repo";
+import { BookRepo } from "~/domains/primary/book/book.repo";
+
+const PRIMARY_CONNECTION = "default";
+const SECONDARY_CONNECTION = "secondary_db";
+@Injectable()
+export class DemoService {
+  constructor(
+    readonly photoRepo: PhotoRepo,
+    @InjectRepo(BookRepo, PRIMARY_CONNECTION)
+    readonly bookRepo: BookRepo
+  ) {}
+
+  @DefTransaction()
+  create(body: any) {
+    return this.photoRepo.save(body);
+  }
+}
+
+// secondary connection
+@Injectable()
+export class DemoService {
+  constructor(
+    @InjectRepo(ExampleRepo, SECONDARY_CONNECTION)
+    readonly exampleRepo: ExampleRepo,
+    @InjectRepo(DataLogRepo, SECONDARY_CONNECTION)
+    readonly dataLogRepo: DataLogRepo
+  ) {}
+
+  @DefTransaction({ connectionName: SECONDARY_CONNECTION })
+  create(body: any) {
+    return this.photoRepo.save(body);
+  }
+}
+```
+
+#### Use wraper Controller and ChildModule
+
+```typescript
+import { DefController } from "nestjs-typeorm3-kit";
+
+@Controller("demo")
+export class DemoController {
+  constructor(private readonly demoService: DemoService) {}
+
+  @DefGet()
+  list(@Query() query: any) {
+    return this.demoService.list(query);
+  }
+
+  @DefPost()
+  create(@Body() body: any) {
+    return this.demoService.create(body);
+  }
+}
+
+// child module suport prefix route and API TAG swagger
+@ChildModule({
+  prefix: REFIX_MODULE.client,
+  imports: [PrimaryRepoModule, SecondaryRepoModule],
+  providers: [DemoService, ExampleService],
+  controllers: [ExampleController, DemoController],
+})
+export class ClientModule implements NestModule {
+  configure(consumer: MiddlewareConsumer) {}
+}
+// setup swagger beautiful in main.ts
+// main.ts
+import { NestFactory } from "@nestjs/core";
+import { AppModule } from "./app.module";
+import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
+import { getFromContainer, MetadataStorage } from "class-validator";
+import { SchemasObject } from "@nestjs/swagger/dist/interfaces/open-api-spec.interface";
+
+import { validationMetadatasToSchemas } from "class-validator-jsonschema";
+import { setupTransactionContext } from "nestjs-typeorm3-kit";
+import { INestApplication } from "@nestjs/common";
+
+const configSwagger = (app: INestApplication) => {
+  const options = new DocumentBuilder()
+    .setTitle("SWAGGER_TITLE")
+    .setDescription("SWAGGER_DESCRIPTION")
+    .setVersion("SWAGGER_VERSION")
+    .addSecurity("bearer", {
+      type: "http",
+      scheme: "bearer",
+      bearerFormat: "JWT",
+    })
+    .build();
+
+  const document = SwaggerModule.createDocument(app as any, options, {
+    // extraModels: [PageResponse]
+  });
+
+  // Creating all the swagger schemas based on the class-validator decorators
+  const metadatas = (getFromContainer(MetadataStorage) as any)
+    .validationMetadatas;
+  const targetSchemas = document.components.schemas || {};
+  const schemasBinding = validationMetadatasToSchemas(metadatas) || {};
+
+  Object.keys(schemasBinding).forEach((key) => {
+    const value = schemasBinding[key] as SchemasObject;
+    if (!targetSchemas[key]) {
+      Object.assign(targetSchemas, { key: value });
+    } else {
+      const targetValue = targetSchemas[key] as SchemasObject;
+
+      Object.assign(targetValue.properties, value.properties);
+      targetValue.required = value.required;
+      Object.assign(targetSchemas, { key: targetValue });
+    }
+  });
+  document.components.schemas = Object.assign({}, targetSchemas);
+  SwaggerModule.setup("swagger", app as any, document);
+};
+
+async function bootstrap() {
+  setupTransactionContext();
+  const app = await NestFactory.create(AppModule);
+  const port = process.env.PORT || 3000;
+  app.enableCors({ origin: "*" });
+  configSwagger(app);
+  await app.listen(port);
+  console.log(
+    `Server start on port ${port}. Open http://localhost:${port} to see results`
+  );
+  console.log(`API DOCUMENT Open http://localhost:${port}/swagger`);
+  console.log(`API DOCUMENT JSON Open http://localhost:${port}/swagger-json`);
+  console.log("TIMEZONE: ", process.env.TZ);
+}
+bootstrap();
+```
+
+![Swagger UI](image.png)
+
 #### Example
 
 [Example](./example)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-typeorm3-kit",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "NestJS utilities for TypeORM v0.3+",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",