@mikro-orm/entity-generator 7.0.0-rc.2 → 7.0.0

package/DefineEntitySourceFile.js

@@ -28,7 +28,7 @@ export class DefineEntitySourceFile extends EntitySchemaSourceFile {
         else {
             entitySchemaOptions.class = this.meta.className;
         }
-        Object.assign(entitySchemaOptions, (this.meta.embeddable ? this.getEmbeddableDeclOptions() : (this.meta.collection ? this.getEntityDeclOptions() : {})));
+        Object.assign(entitySchemaOptions, this.meta.embeddable ? this.getEmbeddableDeclOptions() : this.meta.collection ? this.getEntityDeclOptions() : {});
         const nameSuffix = this.options.inferEntityType ? '' : 'Schema';
         const declLine = `export const ${this.meta.className + nameSuffix} = ${this.referenceCoreImport('defineEntity')}(`;
         ret += declLine;
@@ -81,14 +81,45 @@ export class DefineEntitySourceFile extends EntitySchemaSourceFile {
             }
         }
         const simpleOptions = new Set([
-            'primary', 'ref', 'nullable', 'array', 'object', 'mapToPk', 'hidden', 'concurrencyCheck', 'lazy', 'eager',
-            'orphanRemoval', 'version', 'unsigned', 'returning', 'createForeignKeyConstraint', 'fixedOrder', 'owner',
-            'getter', 'setter', 'unique', 'index', 'hydrate', 'persist', 'autoincrement',
+            'primary',
+            'ref',
+            'nullable',
+            'array',
+            'object',
+            'mapToPk',
+            'hidden',
+            'concurrencyCheck',
+            'lazy',
+            'eager',
+            'orphanRemoval',
+            'version',
+            'unsigned',
+            'returning',
+            'createForeignKeyConstraint',
+            'fixedOrder',
+            'owner',
+            'getter',
+            'setter',
+            'unique',
+            'index',
+            'hydrate',
+            'persist',
+            'autoincrement',
         ]);
         const skipOptions = new Set(['entity', 'kind', 'type', 'items']);
         const spreadOptions = new Set([
-            'fieldNames', 'joinColumns', 'inverseJoinColumns', 'referencedColumnNames', 'ownColumns', 'columnTypes',
-            'cascade', 'ignoreSchemaChanges', 'customOrder', 'groups', 'where', 'orderBy',
+            'fieldNames',
+            'joinColumns',
+            'inverseJoinColumns',
+            'referencedColumnNames',
+            'ownColumns',
+            'columnTypes',
+            'cascade',
+            'ignoreSchemaChanges',
+            'customOrder',
+            'groups',
+            'where',
+            'orderBy',
         ]);
         const rename = {
             fieldName: 'name',

package/EntityGenerator.d.ts

@@ -1,15 +1,7 @@
 import { type GenerateOptions, type MikroORM } from '@mikro-orm/core';
 import { type EntityManager } from '@mikro-orm/sql';
 export declare class EntityGenerator {
-    private readonly em;
-    private readonly config;
-    private readonly driver;
-    private readonly platform;
-    private readonly helper;
-    private readonly connection;
-    private readonly namingStrategy;
-    private readonly sources;
-    private readonly referencedEntities;
+    #private;
     constructor(em: EntityManager);
     static register(orm: MikroORM): void;
     generate(options?: GenerateOptions): Promise<string[]>;

package/EntityGenerator.js

@@ -8,34 +8,34 @@ import { EntitySchemaSourceFile } from './EntitySchemaSourceFile.js';
 import { NativeEnumSourceFile } from './NativeEnumSourceFile.js';
 import { SourceFile } from './SourceFile.js';
 export class EntityGenerator {
-    em;
-    config;
-    driver;
-    platform;
-    helper;
-    connection;
-    namingStrategy;
-    sources = [];
-    referencedEntities = new WeakSet();
+    #config;
+    #driver;
+    #platform;
+    #helper;
+    #connection;
+    #namingStrategy;
+    #sources = [];
+    #referencedEntities = new WeakSet();
+    #em;
     constructor(em) {
-        this.em = em;
-        this.config = this.em.config;
-        this.driver = this.em.getDriver();
-        this.platform = this.driver.getPlatform();
-        this.helper = this.platform.getSchemaHelper();
-        this.connection = this.driver.getConnection();
-        this.namingStrategy = this.config.getNamingStrategy();
+        this.#em = em;
+        this.#config = this.#em.config;
+        this.#driver = this.#em.getDriver();
+        this.#platform = this.#driver.getPlatform();
+        this.#helper = this.#platform.getSchemaHelper();
+        this.#connection = this.#driver.getConnection();
+        this.#namingStrategy = this.#config.getNamingStrategy();
     }
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/entity-generator', () => new EntityGenerator(orm.em));
     }
     async generate(options = {}) {
-        options = Utils.mergeConfig({}, this.config.get('entityGenerator'), options);
-        const schema = await DatabaseSchema.create(this.connection, this.platform, this.config, undefined, undefined, options.takeTables, options.skipTables);
+        options = Utils.mergeConfig({}, this.#config.get('entityGenerator'), options);
+        const schema = await DatabaseSchema.create(this.#connection, this.#platform, this.#config, undefined, undefined, options.takeTables, options.skipTables);
         const metadata = await this.getEntityMetadata(schema, options);
-        const defaultPath = `${this.config.get('baseDir')}/generated-entities`;
+        const defaultPath = `${this.#config.get('baseDir')}/generated-entities`;
         const baseDir = fs.normalizePath(options.path ?? defaultPath);
-        this.sources.length = 0;
+        this.#sources.length = 0;
         const map = {
             defineEntity: DefineEntitySourceFile,
             entitySchema: EntitySchemaSourceFile,
@@ -45,15 +45,15 @@ export class EntityGenerator {
             options.scalarTypeInDecorator = true;
         }
         for (const meta of metadata) {
-            if (meta.pivotTable && !options.outputPurePivotTables && !this.referencedEntities.has(meta)) {
+            if (meta.pivotTable && !options.outputPurePivotTables && !this.#referencedEntities.has(meta)) {
                 continue;
             }
-            this.sources.push(new map[options.entityDefinition](meta, this.namingStrategy, this.platform, options));
+            this.#sources.push(new map[options.entityDefinition](meta, this.#namingStrategy, this.#platform, options));
         }
         for (const nativeEnum of Object.values(schema.getNativeEnums())) {
-            this.sources.push(new NativeEnumSourceFile({}, this.namingStrategy, this.platform, options, nativeEnum));
+            this.#sources.push(new NativeEnumSourceFile({}, this.#namingStrategy, this.#platform, options, nativeEnum));
         }
-        const files = this.sources.map(file => [file.getBaseName(), file.generate()]);
+        const files = this.#sources.map(file => [file.getBaseName(), file.generate()]);
         if (options.save) {
             fs.ensureDir(baseDir);
             const promises = [];
@@ -71,7 +71,8 @@ export class EntityGenerator {
         return files.map(([, data]) => data);
     }
     async getEntityMetadata(schema, options) {
-        const metadata = schema.getTables()
+        const metadata = schema
+            .getTables()
             .filter(table => !options.schema || table.schema === options.schema)
             .sort((a, b) => `${a.schema}.${a.name}`.localeCompare(`${b.schema}.${b.name}`))
             .map(table => {
@@ -83,16 +84,21 @@ export class EntityGenerator {
                     }
                 }
             }
-            return table.getEntityDeclaration(this.namingStrategy, this.helper, options.scalarPropertiesForRelations);
+            return table.getEntityDeclaration(this.#namingStrategy, this.#helper, options.scalarPropertiesForRelations);
         });
         for (const meta of metadata) {
             for (const prop of meta.relations) {
-                if (!metadata.some(otherMeta => prop.referencedTableName === otherMeta.collection || prop.referencedTableName === `${otherMeta.schema ?? schema.name}.${otherMeta.collection}`)) {
+                if (!metadata.some(otherMeta => prop.referencedTableName === otherMeta.collection ||
+                    prop.referencedTableName === `${otherMeta.schema ?? schema.name}.${otherMeta.collection}`)) {
                     prop.kind = ReferenceKind.SCALAR;
-                    const mappedTypes = prop.columnTypes.map((t, i) => this.platform.getMappedType(t));
+                    const mappedTypes = prop.columnTypes.map((t, i) => this.#platform.getMappedType(t));
                     const runtimeTypes = mappedTypes.map(t => t.runtimeType);
                     prop.runtimeType = (runtimeTypes.length === 1 ? runtimeTypes[0] : `[${runtimeTypes.join(', ')}]`);
-                    prop.type = mappedTypes.length === 1 ? (Utils.entries(types).find(([k, v]) => Object.getPrototypeOf(mappedTypes[0]) === v.prototype)?.[0] ?? mappedTypes[0].name) : 'unknown';
+                    prop.type =
+                        mappedTypes.length === 1
+                            ? (Utils.entries(types).find(([k, v]) => Object.getPrototypeOf(mappedTypes[0]) === v.prototype)?.[0] ??
+                                mappedTypes[0].name)
+                            : 'unknown';
                 }
                 const meta2 = metadata.find(meta2 => meta2.className === prop.type);
                 const targetPrimaryColumns = meta2?.getPrimaryProps().flatMap(p => p.fieldNames);
@@ -103,15 +109,17 @@ export class EntityGenerator {
                 }
             }
         }
-        await options.onInitialMetadata?.(metadata, this.platform);
+        await options.onInitialMetadata?.(metadata, this.#platform);
         // enforce schema usage in class names only on duplicates
         const duplicates = Utils.findDuplicates(metadata.map(meta => meta.className));
         for (const duplicate of duplicates) {
             for (const meta of metadata.filter(meta => meta.className === duplicate)) {
-                meta.className = this.namingStrategy.getEntityName(`${meta.schema ?? schema.name}_${meta.className}`);
+                meta.className = this.#namingStrategy.getEntityName(`${meta.schema ?? schema.name}_${meta.className}`);
                 for (const relMeta of metadata) {
                     for (const prop of relMeta.relations) {
-                        if (prop.type === duplicate && (prop.referencedTableName === meta.collection || prop.referencedTableName === `${meta.schema ?? schema.name}.${meta.collection}`)) {
+                        if (prop.type === duplicate &&
+                            (prop.referencedTableName === meta.collection ||
+                                prop.referencedTableName === `${meta.schema ?? schema.name}.${meta.collection}`)) {
                             prop.type = meta.className;
                         }
                     }
@@ -132,7 +140,7 @@ export class EntityGenerator {
         if (options.undefinedDefaults) {
             this.castNullDefaultsToUndefined(metadata);
         }
-        await options.onProcessedMetadata?.(metadata, this.platform);
+        await options.onProcessedMetadata?.(metadata, this.#platform);
         return metadata;
     }
     cleanUpReferentialIntegrityRules(metadata) {
@@ -197,12 +205,14 @@ export class EntityGenerator {
     detectManyToManyRelations(metadata, onlyPurePivotTables, readOnlyPivotTables, outputPurePivotTables) {
         for (const meta of metadata) {
             const isReferenced = metadata.some(m => {
-                return m.tableName !== meta.tableName && m.relations.some(r => {
-                    return r.referencedTableName === meta.tableName && [ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(r.kind);
-                });
+                return (m.tableName !== meta.tableName &&
+                    m.relations.some(r => {
+                        return (r.referencedTableName === meta.tableName &&
+                            [ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(r.kind));
+                    }));
             });
             if (isReferenced) {
-                this.referencedEntities.add(meta);
+                this.#referencedEntities.add(meta);
             }
             // Entities with non-composite PKs are never pivot tables. Skip.
             if (!meta.compositePK) {
@@ -210,8 +220,7 @@ export class EntityGenerator {
             }
             // Entities where there are not exactly 2 PK relations that are both ManyToOne are never pivot tables. Skip.
             const pkRelations = meta.relations.filter(rel => rel.primary);
-            if (pkRelations.length !== 2 ||
-                pkRelations.some(rel => rel.kind !== ReferenceKind.MANY_TO_ONE)) {
+            if (pkRelations.length !== 2 || pkRelations.some(rel => rel.kind !== ReferenceKind.MANY_TO_ONE)) {
                 continue;
             }
             const pkRelationFields = new Set(pkRelations.flatMap(rel => rel.fieldNames));
@@ -227,8 +236,7 @@ export class EntityGenerator {
                     continue;
                 }
                 const pkRelationNames = pkRelations.map(rel => rel.name);
-                let otherProps = meta.props
-                    .filter(prop => !pkRelationNames.includes(prop.name) &&
+                let otherProps = meta.props.filter(prop => !pkRelationNames.includes(prop.name) &&
                     prop.persist !== false && // Skip checking non-persist props
                     prop.fieldNames.some(fieldName => nonPkFields.includes(fieldName)));
                 // Deal with the auto increment column first. That is the column used for fixed ordering, if present.
@@ -255,7 +263,7 @@ export class EntityGenerator {
                 // If this now proven pivot entity has persistent props other than the fixed order column,
                 // output it, by considering it as a referenced one.
                 if (otherProps.length > 0) {
-                    this.referencedEntities.add(meta);
+                    this.#referencedEntities.add(meta);
                 }
             }
             meta.pivotTable = true;
@@ -271,7 +279,7 @@ export class EntityGenerator {
             }
             const owner = metadata.find(m => m.className === meta.relations[0].type);
             const target = metadata.find(m => m.className === meta.relations[1].type);
-            const name = this.namingStrategy.manyToManyPropertyName(owner.className, target.className, meta.tableName, owner.tableName, meta.schema);
+            const name = this.#namingStrategy.manyToManyPropertyName(owner.className, target.className, meta.tableName, owner.tableName, meta.schema);
             const ownerProp = {
                 name,
                 kind: ReferenceKind.MANY_TO_MANY,
@@ -280,7 +288,7 @@ export class EntityGenerator {
                 joinColumns: meta.relations[0].fieldNames,
                 inverseJoinColumns: meta.relations[1].fieldNames,
             };
-            if (outputPurePivotTables || this.referencedEntities.has(meta)) {
+            if (outputPurePivotTables || this.#referencedEntities.has(meta)) {
                 ownerProp.pivotEntity = meta.class;
             }
             if (fixedOrderColumn) {
@@ -296,7 +304,7 @@ export class EntityGenerator {
     generateBidirectionalRelations(metadata, includeUnreferencedPurePivotTables) {
         const filteredMetadata = includeUnreferencedPurePivotTables
             ? metadata
-            : metadata.filter(m => !m.pivotTable || this.referencedEntities.has(m));
+            : metadata.filter(m => !m.pivotTable || this.#referencedEntities.has(m));
         for (const meta of filteredMetadata) {
             for (const prop of meta.relations) {
                 const targetMeta = metadata.find(m => m.className === prop.type);
@@ -327,16 +335,16 @@ export class EntityGenerator {
                     continue;
                 }
                 let i = 1;
-                const name = newProp.name = this.namingStrategy.inverseSideName(meta.className, prop.name, newProp.kind);
+                const name = (newProp.name = this.#namingStrategy.inverseSideName(meta.className, prop.name, newProp.kind));
                 while (targetMeta.properties[newProp.name]) {
-                    newProp.name = name + (i++);
+                    newProp.name = name + i++;
                 }
                 targetMeta.addProperty(newProp);
             }
         }
     }
     generateIdentifiedReferences(metadata) {
-        for (const meta of metadata.filter(m => !m.pivotTable || this.referencedEntities.has(m))) {
+        for (const meta of metadata.filter(m => !m.pivotTable || this.#referencedEntities.has(m))) {
             for (const prop of Object.values(meta.properties)) {
                 if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind) || prop.lazy) {
                     prop.ref = true;

package/EntitySchemaSourceFile.js

@@ -19,7 +19,11 @@ export class EntitySchemaSourceFile extends SourceFile {
         ret += `\n`;
         const entitySchemaOptions = {
             class: this.meta.className,
-            ...(this.meta.embeddable ? this.getEmbeddableDeclOptions() : (this.meta.collection ? this.getEntityDeclOptions() : {})),
+            ...(this.meta.embeddable
+                ? this.getEmbeddableDeclOptions()
+                : this.meta.collection
+                    ? this.getEntityDeclOptions()
+                    : {}),
         };
         const declLine = `export const ${this.meta.className}Schema = new ${this.referenceCoreImport('EntitySchema')}(`;
         ret += declLine;
@@ -72,7 +76,7 @@ export class EntitySchemaSourceFile extends SourceFile {
             const eagerPropertyNames = eagerProperties.map(prop => `'${prop.name}'`).sort();
             classBody += `${' '.repeat(2)}[${this.referenceCoreImport('EagerProps')}]?: ${eagerPropertyNames.join(' | ')};\n`;
         }
-        classBody += `${props.join('')}`;
+        classBody += props.join('');
         return this.getEntityClass(classBody);
     }
     getPropertyOptions(prop, quote = true) {
@@ -122,7 +126,7 @@ export class EntitySchemaSourceFile extends SourceFile {
             }
             const defaultName = this.platform.getIndexName(this.meta.collection, prop.fieldNames, type);
             /* v8 ignore next */
-            options[type] = (propType === true || defaultName === propType) ? 'true' : this.quote(propType);
+            options[type] = propType === true || defaultName === propType ? 'true' : this.quote(propType);
             const expected = {
                 index: this.platform.indexForeignKeys(),
                 unique: prop.kind === ReferenceKind.ONE_TO_ONE,

package/NativeEnumSourceFile.d.ts

@@ -1,11 +1,7 @@
 import type { EntityMetadata, GenerateOptions, NamingStrategy, Platform } from '@mikro-orm/core';
 import { SourceFile } from './SourceFile.js';
 export declare class NativeEnumSourceFile extends SourceFile {
-    protected readonly nativeEnum: {
-        name: string;
-        schema?: string;
-        items: string[];
-    };
+    private readonly nativeEnum;
     constructor(meta: EntityMetadata, namingStrategy: NamingStrategy, platform: Platform, options: GenerateOptions, nativeEnum: {
         name: string;
         schema?: string;

package/README.md

@@ -2,14 +2,14 @@
   <a href="https://mikro-orm.io"><img src="https://raw.githubusercontent.com/mikro-orm/mikro-orm/master/docs/static/img/logo-readme.svg?sanitize=true" alt="MikroORM" /></a>
 </h1>
 
-TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL and SQLite (including libSQL) databases. 
+TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL, SQLite (including libSQL), MSSQL and Oracle databases. 
 
 > Heavily inspired by [Doctrine](https://www.doctrine-project.org/) and [Hibernate](https://hibernate.org/).
 
-[![NPM version](https://img.shields.io/npm/v/@mikro-orm/core.svg)](https://www.npmjs.com/package/@mikro-orm/core)
-[![NPM dev version](https://img.shields.io/npm/v/@mikro-orm/core/next.svg)](https://www.npmjs.com/package/@mikro-orm/core)
+[![NPM version](https://img.shields.io/npm/v/@mikro-orm/core.svg)](https://npmx.dev/package/@mikro-orm/core)
+[![NPM dev version](https://img.shields.io/npm/v/@mikro-orm/core/next.svg)](https://npmx.dev/package/@mikro-orm/core)
 [![Chat on discord](https://img.shields.io/discord/1214904142443839538?label=discord&color=blue)](https://discord.gg/w8bjxFHS7X)
-[![Downloads](https://img.shields.io/npm/dm/@mikro-orm/core.svg)](https://www.npmjs.com/package/@mikro-orm/core)
+[![Downloads](https://img.shields.io/npm/dm/@mikro-orm/core.svg)](https://npmx.dev/package/@mikro-orm/core)
 [![Coverage Status](https://img.shields.io/coveralls/mikro-orm/mikro-orm.svg)](https://coveralls.io/r/mikro-orm/mikro-orm?branch=master)
 [![Build Status](https://github.com/mikro-orm/mikro-orm/workflows/tests/badge.svg?branch=master)](https://github.com/mikro-orm/mikro-orm/actions?workflow=tests)
 
@@ -181,6 +181,7 @@ yarn add @mikro-orm/core @mikro-orm/mysql         # for mysql/mariadb
 yarn add @mikro-orm/core @mikro-orm/mariadb       # for mysql/mariadb
 yarn add @mikro-orm/core @mikro-orm/postgresql    # for postgresql
 yarn add @mikro-orm/core @mikro-orm/mssql         # for mssql
+yarn add @mikro-orm/core @mikro-orm/oracledb      # for oracle
 yarn add @mikro-orm/core @mikro-orm/sqlite        # for sqlite
 yarn add @mikro-orm/core @mikro-orm/libsql        # for libsql
 ```

package/SourceFile.d.ts

@@ -4,6 +4,7 @@ import { type Dictionary, type EmbeddableOptions, type EntityMetadata, type Enti
  */
 export declare const identifierRegex: RegExp;
 export declare class SourceFile {
+    #private;
     protected readonly meta: EntityMetadata;
     protected readonly namingStrategy: NamingStrategy;
     protected readonly platform: Platform;
@@ -34,7 +35,6 @@ export declare class SourceFile {
     private getPropertyDecorator;
     protected getPropertyIndexes(prop: EntityProperty, options: Dictionary): string[];
     protected getCommonDecoratorOptions(options: Dictionary, prop: EntityProperty): void;
-    private propTypeBreakdowns;
     private breakdownOfIType;
     protected getScalarPropertyDecoratorOptions(options: Dictionary, prop: EntityProperty, quote?: boolean): void;
     protected getManyToManyDecoratorOptions(options: Dictionary, prop: EntityProperty): void;