@tsed/mikro-orm 7.0.0-beta.1 → 7.0.0-beta.12

package/readme.md

@@ -11,7 +11,8 @@
 [![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![backers](https://opencollective.com/tsed/tiers/badge.svg)](https://opencollective.com/tsed)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
 
 </div>
 
@@ -33,13 +34,13 @@ A package of Ts.ED framework. See website: https://tsed.io/tutorials/mikro-orm
 
 Currently, `@tsed/mikro-orm` allows you:
 
-- Configure one or more MikroOrm connections via the `@Configuration` decorator. All databases will be initialized
+- Configure one or more MikroORM instances via the `@Configuration` decorator. All databases will be initialized
   when the server starts during the server's `OnInit` phase.
-- Use the Entity MikroOrm as Model for Controllers, AJV Validation and Swagger.
+- Use the Entity MikroORM as Model for Controllers, AJV Validation and Swagger.
 
 ## Installation
 
-To begin, install the MikroOrm module for TS.ED:
+To begin, install the MikroORM module for TS.ED:
 
 <Tabs class="-code">
   <Tab label="NPM">
@@ -81,7 +82,7 @@ import {MikroOrmModule} from "@tsed/mikro-orm";
       ...,
 
       entities: [
-        `${__dirname}/entity/*{.ts,.js}`
+        `./entity/*{.ts,.js}`
       ]
     },
     {
@@ -96,32 +97,32 @@ export class Server {}
 
 The `mikroOrm` options accepts the same configuration object as `init()` from the MikroORM package. Check [this page](https://mikro-orm.io/docs/configuration) for the complete configuration documentation.
 
-## Obtain a connection
+## Obtain ORM instance
 
-`@Connection` decorator lets you retrieve an instance of MikroOrm Connection.
+`@Orm` decorator lets you retrieve an instance of MikroORM.
 
 ```typescript
 import {Injectable, AfterRoutesInit} from "@tsed/common";
-import {Connection} from "@tsed/mikro-orm";
+import {Orm} from "@tsed/mikro-orm";
 import {MikroORM} from "@mikro-orm/core";
 
 @Injectable()
 export class UsersService {
-  @Connection()
-  private readonly connection!: MikroORM;
+  @Orm()
+  private readonly orm!: MikroORM;
 
   async create(user: User): Promise<User> {
     // do something
     // ...
     // Then save
-    await this.connection.em.persistAndFlush(user);
+    await this.orm.em.persistAndFlush(user);
     console.log("Saved a new user with id: " + user.id);
 
     return user;
   }
 
   async find(): Promise<User[]> {
-    const users = await this.connection.em.find(User, {});
+    const users = await this.orm.em.find(User, {});
     console.log("Loaded users: ", users);
 
     return users;
@@ -129,15 +130,15 @@ export class UsersService {
 }
 ```
 
-It's also possible to inject a connection by his name:
+It's also possible to inject an ORM by its context name:
 
 ```ts
 import {Injectable} from "@tsed/di";
 
 @Injectable()
 export class MyService {
-  @Connection("mongo")
-  private readonly connection!: MikroORM;
+  @Orm("mongo")
+  private readonly orm!: MikroORM;
 }
 ```
 
@@ -148,7 +149,7 @@ export class MyService {
 ```typescript
 import {Injectable, AfterRoutesInit} from "@tsed/common";
 import {Em} from "@tsed/mikro-orm";
-import {EntityManager} from '@mikro-orm/mysql'; // Import EntityManager from your driver package or `@mikro-orm/knex`
+import {EntityManager} from "@mikro-orm/mysql"; // Import EntityManager from your driver package or `@mikro-orm/knex`
 
 @Injectable()
 export class UsersService {
@@ -164,16 +165,16 @@ export class UsersService {
 }
 ```
 
-It's also possible to inject Entity manager by his connection name:
+It's also possible to inject Entity manager by his context name:
 
 ```typescript
 import {Injectable, AfterRoutesInit} from "@tsed/common";
 import {Em} from "@tsed/mikro-orm";
-import {EntityManager} from '@mikro-orm/mysql'; // Import EntityManager from your driver package or `@mikro-orm/knex`
+import {EntityManager} from "@mikro-orm/mysql"; // Import EntityManager from your driver package or `@mikro-orm/knex`
 
 @Injectable()
 export class UsersService {
-  @Em("connectionName")
+  @Em("contextName")
   private readonly em!: EntityManager;
 
   async create(user: User): Promise<User> {
@@ -187,7 +188,7 @@ export class UsersService {
 
 ## Use Entity with Controller
 
-To begin, we need to define an Entity MikroOrm like this and use Ts.ED Decorator to define the JSON Schema.
+To begin, we need to define an Entity MikroORM like this and use Ts.ED Decorator to define the JSON Schema.
 
 ```typescript
 import {Property, MaxLength, Required} from "@tsed/common";
@@ -195,31 +196,30 @@ import {Entity, Property, PrimaryKey, Property as Column} from "@mikro-orm/core"
 
 @Entity()
 export class User {
-
   @PrimaryKey()
   @Property()
-  id: number;
+  id!: number;
 
   @Column()
   @MaxLength(100)
   @Required()
-  firstName: string;
+  firstName!: string;
 
   @Column()
   @MaxLength(100)
   @Required()
-  lastName: string;
+  lastName!: string;
 
   @Column()
   @Mininum(0)
   @Maximum(100)
-  age: number;
+  age!: number;
 }
 ```
 
 Now, the model is correctly defined and can be used with a [Controller](https://tsed.io/docs/controllers.html)
 , [AJV validation](tutorials/ajv.md),
-[Swagger](tutorials/swagger.md) and [MikroOrm](https://mikro-orm.io/docs/defining-entities).
+[Swagger](tutorials/swagger.md) and [MikroORM](https://mikro-orm.io/docs/defining-entities).
 
 We can use this model with a Controller like that:
 
@@ -229,7 +229,7 @@ import {Controller, Post, BodyParams, Inject, Post, Get} from "@tsed/common";
 @Controller("/users")
 export class UsersCtrl {
   @Inject()
-  private usersService: UsersService;
+  private readonly usersService!: UsersService;
 
   @Post("/")
   create(@BodyParams() user: User): Promise<User> {
@@ -258,7 +258,7 @@ import {Transactional} from "@tsed/mikro-orm";
 @Controller("/users")
 export class UsersCtrl {
   @Inject()
-  private usersService: UsersService;
+  private readonly usersService!: UsersService;
 
   @Post("/")
   @Transactional()
@@ -278,8 +278,8 @@ By default, the automatic retry policy is disabled. You can implement your own t
 The `@Transactional()` decorator allows you to enable a retry policy for the particular resources. You just need to implement the `RetryStrategy` interface and use `registerProvider()` or `@OverrideProvider()` to register it in the IoC container. Below you can find an example to handle occurred optimistic locks based on [an exponential backoff retry strategy](https://en.wikipedia.org/wiki/Exponential_backoff).
 
 ```ts
-import { OptimisticLockError } from '@mikro-orm/core';
-import { RetryStrategy } from '@tsed/mikro-orm';
+import {OptimisticLockError} from "@mikro-orm/core";
+import {RetryStrategy} from "@tsed/mikro-orm";
 
 export interface ExponentialBackoffOptions {
   maxDepth: number;
@@ -290,16 +290,11 @@ export class ExponentialBackoff implements RetryStrategy {
 
   constructor(private readonly options: ExponentialBackoffOptions) {}
 
-  public async acquire<T extends (...args: unknown[]) => unknown>(
-    task: T
-  ): Promise<ReturnType<T>> {
+  public async acquire<T extends (...args: unknown[]) => unknown>(task: T): Promise<ReturnType<T>> {
     try {
       return (await task()) as ReturnType<T>;
     } catch (e) {
-      if (
-        this.shouldRetry(e as Error) &&
-        this.depth < this.options.maxDepth
-      ) {
+      if (this.shouldRetry(e as Error) && this.depth < this.options.maxDepth) {
         return this.retry(task);
       }
 
@@ -311,9 +306,7 @@ export class ExponentialBackoff implements RetryStrategy {
     return error instanceof OptimisticLockError;
   }
 
-  private async retry<T extends (...args: unknown[]) => unknown>(
-    task: T
-  ): Promise<ReturnType<T>> {
+  private async retry<T extends (...args: unknown[]) => unknown>(task: T): Promise<ReturnType<T>> {
     await this.sleep(2 ** this.depth * 50);
 
     this.depth += 1;
@@ -322,14 +315,14 @@ export class ExponentialBackoff implements RetryStrategy {
   }
 
   private sleep(milliseconds: number): Promise<void> {
-    return new Promise(resolve => setTimeout(resolve, milliseconds));
+    return new Promise((resolve) => setTimeout(resolve, milliseconds));
   }
 }
 
 registerProvider({
   provide: RetryStrategy,
   useFactory(): ExponentialBackoff {
-    return new ExponentialBackoff({maxDepth: 3})
+    return new ExponentialBackoff({maxDepth: 3});
   }
 });
 ```
@@ -345,7 +338,7 @@ import {Transactional} from "@tsed/mikro-orm";
 @Controller("/users")
 export class UsersCtrl {
   @Inject()
-  private usersService: UsersService;
+  private readonly usersService!: UsersService;
 
   @Post("/")
   @Transactional({retry: true})

package/tsconfig.compile.esm.json

@@ -8,16 +8,5 @@
     "declaration": true,
     "declarationDir": "./lib/types"
   },
-  "exclude": [
-    "node_modules",
-    "test",
-    "lib",
-    "benchmark",
-    "coverage",
-    "spec",
-    "**/*.benchmark.ts",
-    "**/*.spec.ts",
-    "keys",
-    "jest.config.js"
-  ]
+  "exclude": ["node_modules", "test", "lib", "benchmark", "coverage", "spec", "**/*.benchmark.ts", "**/*.spec.ts", "keys", "jest.config.js"]
 }

package/lib/cjs/decorators/connection.d.ts

@@ -1 +0,0 @@
-export declare const Connection: (connectionName?: string | undefined) => PropertyDecorator;

package/lib/cjs/decorators/connection.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Connection = void 0;
-const services_1 = require("../services");
-const di_1 = require("@tsed/di");
-const Connection = (connectionName) => (0, di_1.Inject)(services_1.MikroOrmRegistry, (registry) => registry.get(connectionName));
-exports.Connection = Connection;
-//# sourceMappingURL=connection.js.map

package/lib/cjs/decorators/connection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../../src/decorators/connection.ts"],"names":[],"mappings":";;;AAAA,0CAA6C;AAC7C,iCAAgC;AAEzB,MAAM,UAAU,GAAG,CAAC,cAAuB,EAAqB,EAAE,CACvE,IAAA,WAAM,EAAC,2BAAgB,EAAE,CAAC,QAA0B,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAsB,CAAC;AADjG,QAAA,UAAU,cACuF","sourcesContent":["import {MikroOrmRegistry} from \"../services\";\nimport {Inject} from \"@tsed/di\";\n\nexport const Connection = (connectionName?: string): PropertyDecorator =>\n  Inject(MikroOrmRegistry, (registry: MikroOrmRegistry) => registry.get(connectionName)) as PropertyDecorator;\n"]}

package/lib/cjs/decorators/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./transactional";
-export * from "./connection";
-export * from "./entityManager";

package/lib/cjs/decorators/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./transactional"), exports);
-(0, tslib_1.__exportStar)(require("./connection"), exports);
-(0, tslib_1.__exportStar)(require("./entityManager"), exports);
-//# sourceMappingURL=index.js.map

package/lib/cjs/decorators/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/decorators/index.ts"],"names":[],"mappings":";;;AAAA,+DAAgC;AAChC,4DAA6B;AAC7B,+DAAgC","sourcesContent":["export * from \"./transactional\";\nexport * from \"./connection\";\nexport * from \"./entityManager\";\n"]}

package/lib/cjs/filters/index.d.ts

@@ -1 +0,0 @@
-export * from "./OptimisticLockErrorFilter";

package/lib/cjs/filters/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./OptimisticLockErrorFilter"), exports);
-//# sourceMappingURL=index.js.map

package/lib/cjs/filters/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/filters/index.ts"],"names":[],"mappings":";;;AAAA,2EAA4C","sourcesContent":["export * from \"./OptimisticLockErrorFilter\";\n"]}

package/lib/cjs/interceptors/index.d.ts

@@ -1 +0,0 @@
-export * from "./TransactionalInterceptor";

package/lib/cjs/interceptors/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./TransactionalInterceptor"), exports);
-//# sourceMappingURL=index.js.map

package/lib/cjs/interceptors/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interceptors/index.ts"],"names":[],"mappings":";;;AAAA,0EAA2C","sourcesContent":["export * from \"./TransactionalInterceptor\";\n"]}

package/lib/cjs/services/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./DBContext";
-export * from "./MikroOrmFactory";
-export * from "./MikroOrmRegistry";
-export * from "./RetryStrategy";

package/lib/cjs/services/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./DBContext"), exports);
-(0, tslib_1.__exportStar)(require("./MikroOrmFactory"), exports);
-(0, tslib_1.__exportStar)(require("./MikroOrmRegistry"), exports);
-(0, tslib_1.__exportStar)(require("./RetryStrategy"), exports);
-//# sourceMappingURL=index.js.map

package/lib/cjs/services/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/index.ts"],"names":[],"mappings":";;;AAAA,2DAA4B;AAC5B,iEAAkC;AAClC,kEAAmC;AACnC,+DAAgC","sourcesContent":["export * from \"./DBContext\";\nexport * from \"./MikroOrmFactory\";\nexport * from \"./MikroOrmRegistry\";\nexport * from \"./RetryStrategy\";\n"]}

package/lib/esm/decorators/connection.js

@@ -1,4 +0,0 @@
-import { MikroOrmRegistry } from "../services";
-import { Inject } from "@tsed/di";
-export const Connection = (connectionName) => Inject(MikroOrmRegistry, (registry) => registry.get(connectionName));
-//# sourceMappingURL=connection.js.map

package/lib/esm/decorators/connection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../../src/decorators/connection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAEhC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,cAAuB,EAAqB,EAAE,CACvE,MAAM,CAAC,gBAAgB,EAAE,CAAC,QAA0B,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAsB,CAAC","sourcesContent":["import {MikroOrmRegistry} from \"../services\";\nimport {Inject} from \"@tsed/di\";\n\nexport const Connection = (connectionName?: string): PropertyDecorator =>\n  Inject(MikroOrmRegistry, (registry: MikroOrmRegistry) => registry.get(connectionName)) as PropertyDecorator;\n"]}

package/lib/esm/decorators/index.js

@@ -1,4 +0,0 @@
-export * from "./transactional";
-export * from "./connection";
-export * from "./entityManager";
-//# sourceMappingURL=index.js.map

package/lib/esm/decorators/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC","sourcesContent":["export * from \"./transactional\";\nexport * from \"./connection\";\nexport * from \"./entityManager\";\n"]}

package/lib/esm/filters/index.js

@@ -1,2 +0,0 @@
-export * from "./OptimisticLockErrorFilter";
-//# sourceMappingURL=index.js.map

package/lib/esm/filters/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/filters/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC","sourcesContent":["export * from \"./OptimisticLockErrorFilter\";\n"]}

package/lib/esm/interceptors/index.js

@@ -1,2 +0,0 @@
-export * from "./TransactionalInterceptor";
-//# sourceMappingURL=index.js.map

package/lib/esm/interceptors/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interceptors/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC","sourcesContent":["export * from \"./TransactionalInterceptor\";\n"]}

package/lib/esm/services/index.js

@@ -1,5 +0,0 @@
-export * from "./DBContext";
-export * from "./MikroOrmFactory";
-export * from "./MikroOrmRegistry";
-export * from "./RetryStrategy";
-//# sourceMappingURL=index.js.map

package/lib/esm/services/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC","sourcesContent":["export * from \"./DBContext\";\nexport * from \"./MikroOrmFactory\";\nexport * from \"./MikroOrmRegistry\";\nexport * from \"./RetryStrategy\";\n"]}

package/lib/types/decorators/connection.d.ts

@@ -1 +0,0 @@
-export declare const Connection: (connectionName?: string | undefined) => PropertyDecorator;

package/lib/types/decorators/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./transactional";
-export * from "./connection";
-export * from "./entityManager";

package/lib/types/filters/index.d.ts

@@ -1 +0,0 @@
-export * from "./OptimisticLockErrorFilter";

package/lib/types/interceptors/index.d.ts

@@ -1 +0,0 @@
-export * from "./TransactionalInterceptor";

package/lib/types/services/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./DBContext";
-export * from "./MikroOrmFactory";
-export * from "./MikroOrmRegistry";
-export * from "./RetryStrategy";