feat(mongoose): Added DynamicRef decorator to support mongoose dynamic refs. Issue #567

Author: Gustavo Mendonça

packages/mongoose/src/decorators/dynamicRef.ts

@@ -0,0 +1,54 @@
+import {Property, Schema} from "@tsed/common";
+import {applyDecorators, Store, StoreFn, StoreMerge} from "@tsed/core";
+import {Schema as MongooseSchema} from "mongoose";
+import {MONGOOSE_SCHEMA} from "../constants";
+
+/**
+ * Define a property as mongoose reference to other Model (decorated with @Model).
+ *
+ * ### Example
+ *
+ * ```typescript
+ *
+ * @Model()
+ * class FooModel {
+ *
+ *    @DynamicRef('type')
+ *    field: Ref<OtherFooModel | OtherModel>
+ *
+ *    @Enum(['OtherFooModel', 'OtherModel'])
+ *    type: string
+ * }
+ *
+ * @Model()
+ * class OtherFooModel {
+ * }
+ *
+ * @Model()
+ * class OtherModel {
+ * }
+ * ```
+ *
+ * @param type
+ * @returns {Function}
+ * @decorator
+ * @mongoose
+ * @property
+ */
+export function DynamicRef(refPath: string) {
+  return applyDecorators(
+    Property({use: String}),
+    Schema({
+      type: String,
+      example: "5ce7ad3028890bd71749d477",
+      description: "Mongoose Ref ObjectId"
+    }),
+    StoreFn((store: Store) => {
+      delete store.get("schema").$ref;
+    }),
+    StoreMerge(MONGOOSE_SCHEMA, {
+      type: MongooseSchema.Types.ObjectId,
+      refPath
+    })
+  );
+}

packages/mongoose/src/decorators/index.ts

@@ -10,3 +10,4 @@ export * from "./select";
 export * from "./unique";
 export * from "./virtualRef";
 export * from "./objectID";
+export * from "./dynamicRef";