@tsed/mikro-orm 7.31.0-rc.2 → 7.32.0

package/lib/types/MikroOrmModule.d.ts

@@ -1,11 +1,11 @@
 import "./services/MikroOrmFactory";
 import { AlterRunInContext, OnDestroy, OnInit } from "@tsed/di";
-import { Options } from "@mikro-orm/core";
+import { EventSubscriber, Options } from "@mikro-orm/core";
 declare global {
     namespace TsED {
         interface Configuration {
             /**
-             * The the ORM configuration, entity metadata.
+             * The ORM configuration, entity metadata.
              * If you omit the `options` parameter, your CLI config will be used.
              */
             mikroOrm?: Options[];
@@ -13,11 +13,17 @@ declare global {
     }
 }
 export declare class MikroOrmModule implements OnDestroy, OnInit, AlterRunInContext {
+    private subscribers;
     private readonly settings;
     private readonly registry;
     private readonly context;
+    private readonly injector;
+    constructor(subscribers: EventSubscriber[]);
     $onInit(): Promise<void>;
     $onDestroy(): Promise<void>;
     $alterRunInContext(next: (...args: unknown[]) => unknown): () => unknown | Promise<() => unknown>;
+    private getSubscribers;
+    private getUnmanagedSubscribers;
+    private getManagedSubscribers;
     private createContext;
 }

package/lib/types/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_CONTEXT_NAME = "default";
+export declare const SUBSCRIBER_INJECTION_TYPE: unique symbol;

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

@@ -0,0 +1,8 @@
+/**
+ * Register a new subscriber for the given context name.
+ * @decorator
+ * @mikroOrm
+ */
+export declare const Subscriber: (options?: {
+    contextName: string;
+}) => any;

package/lib/types/index.d.ts

@@ -2,8 +2,10 @@
  * @file Automatically generated by barrelsby.
  */
 export * from "./MikroOrmModule";
+export * from "./constants";
 export * from "./decorators/entityManager";
 export * from "./decorators/orm";
+export * from "./decorators/subscriber";
 export * from "./decorators/transactional";
 export * from "./filters/OptimisticLockErrorFilter";
 export * from "./interceptors/TransactionalInterceptor";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/mikro-orm",
-  "version": "7.31.0-rc.2",
+  "version": "7.32.0",
   "description": "MikroORM package for Ts.ED framework",
   "private": false,
   "source": "./src/index.ts",
@@ -27,23 +27,23 @@
   "devDependencies": {
     "@mikro-orm/core": "^5.2.2",
     "@mikro-orm/mongodb": "^5.2.2",
-    "@tsed/common": "7.31.0-rc.2",
-    "@tsed/core": "7.31.0-rc.2",
-    "@tsed/di": "7.31.0-rc.2",
-    "@tsed/eslint": "7.31.0-rc.2",
-    "@tsed/json-mapper": "7.31.0-rc.2",
+    "@tsed/common": "7.32.0",
+    "@tsed/core": "7.32.0",
+    "@tsed/di": "7.32.0",
+    "@tsed/eslint": "7.32.0",
+    "@tsed/json-mapper": "7.32.0",
     "@tsed/logger": ">=6.1.1",
-    "@tsed/schema": "7.31.0-rc.2",
-    "@tsed/testing-mongoose": "7.31.0-rc.2",
-    "@tsed/typescript": "7.31.0-rc.2",
+    "@tsed/schema": "7.32.0",
+    "@tsed/testing-mongoose": "7.32.0",
+    "@tsed/typescript": "7.32.0",
     "eslint": "^8.12.0",
     "ts-mockito": "^2.6.1"
   },
   "peerDependencies": {
     "@mikro-orm/core": ">=4.5.9",
-    "@tsed/common": "^7.31.0-rc.2",
-    "@tsed/core": "^7.31.0-rc.2",
-    "@tsed/di": "^7.31.0-rc.2",
+    "@tsed/common": "^7.32.0",
+    "@tsed/core": "^7.32.0",
+    "@tsed/di": "^7.32.0",
     "@tsed/logger": ">=6.2.2"
   },
   "repository": "https://github.com/tsedio/tsed",
@@ -52,8 +52,5 @@
   },
   "homepage": "https://github.com/tsedio/tsed/tree/production/packages/orm/mikro-orm",
   "author": "Romain Lenzotti",
-  "license": "MIT",
-  "publishConfig": {
-    "tag": "rc"
-  }
+  "license": "MIT"
 }

package/readme.md

@@ -389,6 +389,34 @@ export class UsersCtrl {
 }
 ```
 
+## Managing Lifecycle of Subscribers
+
+With Ts.ED, managing the lifecycle of subscribers registered with Mikro-ORM using the IoC container is simple. To automatically resolve a subscriber's dependencies, you can use the `@Subscriber` decorator as follows:
+
+```typescript
+import {EventSubscriber} from "@mikro-orm/core";
+import {Subscriber} from "@tsed/mikro-orm";
+
+@Subscriber()
+export class SomeSubscriber implements EventSubscriber {
+  // ...
+}
+```
+
+In this example, we register the `SomeSubscriber` subscriber, which is automatically instantiated by the module using the IoC container, allowing you to easily manage the dependencies of your subscribers.
+
+You can also specify the context name for a subscriber to tie it to a particular instance of the ORM:
+
+```typescript
+import {EventSubscriber} from "@mikro-orm/core";
+import {Subscriber} from "@tsed/mikro-orm";
+
+@Subscriber({contextName: "mongodb"})
+export class SomeSubscriber implements EventSubscriber {
+  // ...
+}
+```
+
 ## Contributors
 
 Please read [contributing guidelines here](https://tsed.io/contributing.html)