feat(entity-generator): allow generating identified references

mikro-orm · Jun 8, 2022 · 1fbf5ac · 1fbf5ac
1 parent 5203ee7
commit 1fbf5ac
Show file tree

Hide file tree

Showing 6 changed files with 606 additions and 1 deletion.
diff --git a/docs/docs/entity-generator.md b/docs/docs/entity-generator.md
@@ -46,7 +46,7 @@ $ ts-node generate-entities
 
 ## Advanced
 
-By default, the `EntityGenerator` generates only owning sides of relations (e.g. M:1). We can configure it via `entityGenerator: { bidirectionalRelations: true }` to generate also the inverse sides for them. 
+By default, the `EntityGenerator` generates only owning sides of relations (e.g. M:1). We can configure it via `entityGenerator: { bidirectionalRelations: true }` to generate also the inverse sides for them. To generate M:1 and 1:1 relations as wrapped references, use `entityGenerator: { identifiedReferences: true }`.
 
 ## Current limitations
 

diff --git a/packages/core/src/utils/Configuration.ts b/packages/core/src/utils/Configuration.ts
@@ -100,6 +100,7 @@ export class Configuration<D extends IDatabaseDriver = IDatabaseDriver> {
     },
     entityGenerator: {
       bidirectionalRelations: false,
+      identifiedReferences: false,
     },
     cache: {
       pretty: false,
@@ -481,6 +482,7 @@ export interface MikroORMOptions<D extends IDatabaseDriver = IDatabaseDriver> ex
   };
   entityGenerator: {
     bidirectionalRelations?: boolean;
+    identifiedReferences?: boolean;
   };
   cache: {
     enabled?: boolean;

diff --git a/packages/entity-generator/src/EntityGenerator.ts b/packages/entity-generator/src/EntityGenerator.ts
@@ -31,6 +31,10 @@ export class EntityGenerator {
       this.generateBidirectionalRelations(metadata);
     }
 
+    if (this.config.get('entityGenerator').identifiedReferences) {
+      this.generateIdentifiedReferences(metadata);
+    }
+
     for (const meta of metadata) {
       if (!meta.pivotTable) {
         this.sources.push(new SourceFile(meta, this.namingStrategy, this.platform));
@@ -98,4 +102,14 @@ export class EntityGenerator {
     }
   }
 
+  private generateIdentifiedReferences(metadata: EntityMetadata[]): void {
+    for (const meta of metadata.filter(m => !m.pivotTable)) {
+      for (const prop of meta.relations) {
+        if ([ReferenceType.MANY_TO_ONE, ReferenceType.ONE_TO_ONE].includes(prop.reference)) {
+          prop.wrappedReference = true;
+        }
+      }
+    }
+  }
+
 }
diff --git a/packages/entity-generator/src/SourceFile.ts b/packages/entity-generator/src/SourceFile.ts
@@ -95,6 +95,12 @@ export class SourceFile {
     const isEnumOrNonStringDefault = prop.enum || typeof prop.default !== 'string';
     const useDefault = prop.default != null && isEnumOrNonStringDefault;
     const optional = prop.nullable ? '?' : (useDefault ? '' : '!');
+
+    if (prop.wrappedReference) {
+      this.coreImports.add('IdentifiedReference');
+      return `${padding}${prop.name}${optional}: IdentifiedReference<${prop.type}>;\n`;
+    }
+
     const ret = `${prop.name}${optional}: ${prop.type}`;
 
     if (!useDefault) {
@@ -284,6 +290,10 @@ export class SourceFile {
     this.entityImports.add(className);
     options.entity = `() => ${className}`;
 
+    if (prop.wrappedReference) {
+      options.wrappedReference = true;
+    }
+
     if (prop.mappedBy) {
       options.mappedBy = this.quote(prop.mappedBy);
       return;

diff --git a/tests/features/entity-generator/EntityGenerator.test.ts b/tests/features/entity-generator/EntityGenerator.test.ts
@@ -28,6 +28,22 @@ describe('EntityGenerator', () => {
     await orm.close(true);
   });
 
+  test('generate entities with bidirectional relations and reference wrappers [mysql]', async () => {
+    const orm = await initORMMySql('mysql', {
+      entityGenerator: {
+        bidirectionalRelations: true,
+        identifiedReferences: true,
+      },
+    }, true);
+    const generator = orm.getEntityGenerator();
+    const dump = await generator.generate({ save: true, baseDir: './temp/entities' });
+    expect(dump).toMatchSnapshot('mysql-entity-bidirectional-dump');
+    await expect(pathExists('./temp/entities/Author2.ts')).resolves.toBe(true);
+    await remove('./temp/entities');
+
+    await orm.close(true);
+  });
+
   test('generate entities from schema [sqlite]', async () => {
     const orm = await initORMSqlite();
     const generator = new EntityGenerator(orm.em);