nestjs-typeorm3-kit 0.1.2 → 0.1.4

package/README.md

@@ -0,0 +1,251 @@
+# nestjs-typeorm3-kit
+
+[![npm](https://img.shields.io/npm/v/nestjs-typeorm3-kit)](https://www.npmjs.com/package/nestjs-typeorm3-kit) ![MIT License](https://img.shields.io/npm/l/nestjs-typeorm3-kit.svg)
+
+## [Node.js] nestjs-typeorm3-kit
+
+### Installation
+
+#### NPM
+
+```bash
+npm install nestjs-typeorm3-kit typeorm-transactional
+```
+
+#### Yarn
+
+```bash
+yarn add nestjs-typeorm3-kit typeorm-transactional
+```
+
+#### pnpm
+
+```bash
+pnpm add nestjs-typeorm3-kit typeorm-transactional
+```
+
+#### bun
+
+```bash
+bun add nestjs-typeorm3-kit typeorm-transactional
+```
+
+### Config after install
+
+#### Use @DefEntityRepository
+
+For using `@DefEntityRepository` instead of `@EntityRepository` of typeorm 0.2, you need to add the following code in `main.ts` or `app.module.ts`:
+
+```typescript
+import { TypeOrmModule } from "@nestjs/typeorm";
+
+TypeOrmModule.forRootAsync({
+  useFactory: () => ({
+    type: "postgres",
+    host: "localhost",
+    port: 5432,
+    username: "postgres",
+    password: "Abc12345",
+    database: "primary_db",
+    entities: [join(__dirname, "./domains/primary/**/*.entity.{ts,js}")],
+    synchronize: true,
+    autoLoadEntities: true,
+    retryAttempts: 2,
+    retryDelay: 1000,
+  }),
+  dataSourceFactory: async (options: DataSourceOptions) => {
+    if (!options) {
+      throw new Error("Invalid options passed");
+    }
+    return addTransactionalDataSource({
+      dataSource: new DataSource(options),
+      name: PRIMARY_CONNECTION,
+    });
+  },
+});
+```
+
+#### create Repository module Use @DefRepositoryModule
+
+```typescript
+import { Module } from "@nestjs/common";
+import { join } from "path";
+
+import { PRIMARY_CONNECTION } from "~/common/constants";
+import { DefRepositoryModule } from "nestjs-typeorm3-kit";
+@Module({
+  imports: [
+    DefRepositoryModule.forRootAsync({
+      useFactory: () => ({
+        globPattern: join(__dirname, "./**/*.repo.{ts,js}"),
+        dataSource: PRIMARY_CONNECTION,
+      }),
+    }),
+  ],
+  exports: [DefRepositoryModule],
+})
+export class PrimaryRepoModule {}
+```
+
+or
+
+```typescript
+import { Module } from "@nestjs/common";
+import { join } from "path";
+
+import { PRIMARY_CONNECTION } from "~/common/constants";
+import { DefRepositoryModule } from "nestjs-typeorm3-kit";
+@Module({
+  imports: [
+    DefRepositoryModule.forFeature([BookRepo, PhotoRepo], PRIMARY_CONNECTION),
+  ],
+  exports: [DefRepositoryModule],
+})
+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();
+```
+
+#### Example
+
+[Example](./example)
+
+### Full document in wiki github
+
+[FULL DOCUMENT](https://x302502.github.io/nestjs-typeorm3-kit/)

package/dist/transaction/setup/index.d.ts

@@ -1,2 +1,4 @@
+import { addTransactionalDataSource } from "typeorm-transactional";
 export declare function setupTransactionContext(): void;
+export { addTransactionalDataSource };
 //# sourceMappingURL=index.d.ts.map

package/dist/transaction/setup/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transaction/setup/index.ts"],"names":[],"mappings":"AACA,wBAAgB,uBAAuB,SAEtC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transaction/setup/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,0BAA0B,EAC3B,MAAM,uBAAuB,CAAC;AAC/B,wBAAgB,uBAAuB,SAEtC;AAED,OAAO,EAAE,0BAA0B,EAAE,CAAC"}

package/dist/transaction/setup/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.addTransactionalDataSource = void 0;
 exports.setupTransactionContext = setupTransactionContext;
 const typeorm_transactional_1 = require("typeorm-transactional");
+Object.defineProperty(exports, "addTransactionalDataSource", { enumerable: true, get: function () { return typeorm_transactional_1.addTransactionalDataSource; } });
 function setupTransactionContext() {
     (0, typeorm_transactional_1.initializeTransactionalContext)();
 }

package/dist/transaction/setup/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transaction/setup/index.ts"],"names":[],"mappings":";;AACA,0DAEC;AAHD,iEAAuE;AACvE,SAAgB,uBAAuB;IACrC,IAAA,sDAA8B,GAAE,CAAC;AACnC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transaction/setup/index.ts"],"names":[],"mappings":";;;AAIA,0DAEC;AAND,iEAG+B;AAKtB,2GANP,kDAA0B,OAMO;AAJnC,SAAgB,uBAAuB;IACrC,IAAA,sDAA8B,GAAE,CAAC;AACnC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-typeorm3-kit",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "NestJS utilities for TypeORM v0.3+",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,12 +38,14 @@
     "libphonenumber-js": "^1.10.20",
     "reflect-metadata": ">=0.1.13",
     "rxjs": ">=7.2.0",
-    "typeorm": ">=0.3.0"
+    "typeorm": ">=0.3.0",
+    "typeorm-transactional": ">=0.5.0"
   },
   "devDependencies": {
     "@nestjs/common": "^11.1.3",
     "@nestjs/core": "^11.1.3",
     "@nestjs/swagger": "^11.2.0",
+    "@nestjs/testing": "^11.1.3",
     "@nestjs/typeorm": "^11.0.0",
     "@types/jest": "^30.0.0",
     "class-transformer": "^0.5.1",
@@ -55,6 +57,7 @@
     "prettier": "^3.6.2",
     "reflect-metadata": "^0.2.2",
     "rimraf": "^6.0.1",
+    "rxjs": "^7.8.2",
     "ts-jest": "^29.4.0",
     "typedoc": "^0.28.6",
     "typedoc-github-wiki-theme": "^2.1.0",