@mikro-orm/entity-generator 7.0.0-dev.33 → 7.0.0-dev.331

package/EntitySchemaSourceFile.js

@@ -2,21 +2,60 @@ import { Config, ReferenceKind, } from '@mikro-orm/core';
 import { SourceFile } from './SourceFile.js';
 export class EntitySchemaSourceFile extends SourceFile {
     generate() {
+        const classDefinition = this.generateClassDefinition();
+        const enumDefinitions = [];
+        for (const prop of Object.values(this.meta.properties)) {
+            if (prop.enum && (typeof prop.kind === 'undefined' || prop.kind === ReferenceKind.SCALAR)) {
+                const def = this.getEnumClassDefinition(prop, 2);
+                if (def.length) {
+                    enumDefinitions.push(def);
+                }
+            }
+        }
+        let ret = classDefinition;
+        if (enumDefinitions.length) {
+            ret += '\n' + enumDefinitions.join('\n');
+        }
+        ret += `\n`;
+        const entitySchemaOptions = {
+            class: this.meta.className,
+            ...(this.meta.embeddable
+                ? this.getEmbeddableDeclOptions()
+                : this.meta.collection
+                    ? this.getEntityDeclOptions()
+                    : {}),
+        };
+        const declLine = `export const ${this.meta.className}Schema = new ${this.referenceCoreImport('EntitySchema')}(`;
+        ret += declLine;
+        if (this.meta.indexes.length > 0) {
+            entitySchemaOptions.indexes = this.meta.indexes.map(index => this.getIndexOptions(index));
+        }
+        if (this.meta.uniques.length > 0) {
+            entitySchemaOptions.uniques = this.meta.uniques.map(index => this.getUniqueOptions(index));
+        }
+        entitySchemaOptions.properties = Object.fromEntries(Object.entries(this.meta.properties).map(([name, prop]) => [name, this.getPropertyOptions(prop)]));
+        // Force top level and properties to be indented, regardless of line length
+        entitySchemaOptions[Config] = true;
+        entitySchemaOptions.properties[Config] = true;
+        ret += this.serializeObject(entitySchemaOptions, declLine.length > 80 ? undefined : 80 - declLine.length, 0);
+        ret += ');\n';
+        ret = `${this.generateImports()}\n\n${ret}`;
+        return ret;
+    }
+    generateClassDefinition() {
         let classBody = '';
-        if (this.meta.className === this.options.customBaseEntityName) {
+        if (!this.options.customBaseEntityName || this.meta.className === this.options.customBaseEntityName) {
             const defineConfigTypeSettings = {};
             defineConfigTypeSettings.forceObject = this.platform.getConfig().get('serialization').forceObject ?? false;
-            classBody += `${' '.repeat(2)}[${this.referenceCoreImport('Config')}]?: ${this.referenceCoreImport('DefineConfig')}<${this.serializeObject(defineConfigTypeSettings)}>;\n`;
+            if (defineConfigTypeSettings.forceObject) {
+                classBody += `${' '.repeat(2)}[${this.referenceCoreImport('Config')}]?: ${this.referenceCoreImport('DefineConfig')}<${this.serializeObject(defineConfigTypeSettings)}>;\n`;
+            }
         }
-        const enumDefinitions = [];
         const eagerProperties = [];
         const primaryProps = [];
         const props = [];
         for (const prop of Object.values(this.meta.properties)) {
             props.push(this.getPropertyDefinition(prop, 2));
-            if (prop.enum && (typeof prop.kind === 'undefined' || prop.kind === ReferenceKind.SCALAR)) {
-                enumDefinitions.push(this.getEnumClassDefinition(prop, 2));
-            }
             if (prop.eager) {
                 eagerProperties.push(prop);
             }
@@ -37,34 +76,10 @@ 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('')}`;
-        let ret = this.getEntityClass(classBody);
-        if (enumDefinitions.length) {
-            ret += '\n' + enumDefinitions.join('\n');
-        }
-        ret += `\n`;
-        const entitySchemaOptions = {
-            class: this.meta.className,
-            ...(this.meta.embeddable ? this.getEmbeddableDeclOptions() : (this.meta.collection ? this.getEntityDeclOptions() : {})),
-        };
-        const declLine = `export const ${this.meta.className}Schema = new ${this.referenceCoreImport('EntitySchema')}(`;
-        ret += declLine;
-        if (this.meta.indexes.length > 0) {
-            entitySchemaOptions.indexes = this.meta.indexes.map(index => this.getIndexOptions(index));
-        }
-        if (this.meta.uniques.length > 0) {
-            entitySchemaOptions.uniques = this.meta.uniques.map(index => this.getUniqueOptions(index));
-        }
-        entitySchemaOptions.properties = Object.fromEntries(Object.entries(this.meta.properties).map(([name, prop]) => [name, this.getPropertyOptions(prop)]));
-        // Force top level and properties to be indented, regardless of line length
-        entitySchemaOptions[Config] = true;
-        entitySchemaOptions.properties[Config] = true;
-        ret += this.serializeObject(entitySchemaOptions, declLine.length > 80 ? undefined : 80 - declLine.length, 0);
-        ret += ');\n';
-        ret = `${this.generateImports()}\n\n${ret}`;
-        return ret;
+        classBody += props.join('');
+        return this.getEntityClass(classBody);
     }
-    getPropertyOptions(prop) {
+    getPropertyOptions(prop, quote = true) {
         const options = {};
         if (prop.primary) {
             options.primary = true;
@@ -79,7 +94,7 @@ export class EntitySchemaSourceFile extends SourceFile {
             this.getOneToManyDecoratorOptions(options, prop);
         }
         else if (prop.kind === ReferenceKind.SCALAR || typeof prop.kind === 'undefined') {
-            this.getScalarPropertyDecoratorOptions(options, prop);
+            this.getScalarPropertyDecoratorOptions(options, prop, quote);
         }
         else if (prop.kind === ReferenceKind.EMBEDDED) {
             this.getEmbeddedPropertyDeclarationOptions(options, prop);
@@ -111,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,
@@ -123,14 +138,14 @@ export class EntitySchemaSourceFile extends SourceFile {
         processIndex('index');
         processIndex('unique');
     }
-    getScalarPropertyDecoratorOptions(options, prop) {
+    getScalarPropertyDecoratorOptions(options, prop, quote = true) {
         if (prop.enum) {
             options.enum = true;
             options.items = `() => ${prop.runtimeType}`;
         }
         else {
-            options.type = this.quote(prop.type);
+            options.type = quote ? this.quote(prop.type) : prop.type;
         }
-        super.getScalarPropertyDecoratorOptions(options, prop);
+        super.getScalarPropertyDecoratorOptions(options, prop, quote);
     }
 }

package/NativeEnumSourceFile.d.ts

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

package/NativeEnumSourceFile.js

@@ -0,0 +1,47 @@
+import { identifierRegex, SourceFile } from './SourceFile.js';
+export class NativeEnumSourceFile extends SourceFile {
+    nativeEnum;
+    constructor(meta, namingStrategy, platform, options, nativeEnum) {
+        super(meta, namingStrategy, platform, options);
+        this.nativeEnum = nativeEnum;
+    }
+    generate() {
+        const enumClassName = this.namingStrategy.getEnumClassName(this.nativeEnum.name, undefined, this.nativeEnum.schema);
+        const enumTypeName = this.namingStrategy.getEnumTypeName(this.nativeEnum.name, undefined, this.nativeEnum.schema);
+        const padding = '  ';
+        const enumMode = this.options.enumMode;
+        const enumValues = this.nativeEnum.items;
+        if (enumMode === 'union-type') {
+            return `export type ${enumTypeName} = ${enumValues.map(item => this.quote(item)).join(' | ')};\n`;
+        }
+        let ret = '';
+        if (enumMode === 'dictionary') {
+            ret += `export const ${enumClassName} = {\n`;
+        }
+        else {
+            ret += `export enum ${enumClassName} {\n`;
+        }
+        for (const enumValue of enumValues) {
+            const enumName = this.namingStrategy.enumValueToEnumProperty(enumValue, this.nativeEnum.name, '', this.nativeEnum.schema);
+            if (enumMode === 'dictionary') {
+                ret += `${padding}${identifierRegex.test(enumName) ? enumName : this.quote(enumName)}: ${this.quote(enumValue)},\n`;
+            }
+            else {
+                ret += `${padding}${identifierRegex.test(enumName) ? enumName : this.quote(enumName)} = ${this.quote(enumValue)},\n`;
+            }
+        }
+        if (enumMode === 'dictionary') {
+            ret += '} as const;\n';
+        }
+        else {
+            ret += '}\n';
+        }
+        if (enumMode === 'dictionary') {
+            ret += `\nexport type ${enumTypeName} = (typeof ${enumClassName})[keyof typeof ${enumClassName}];\n`;
+        }
+        return ret;
+    }
+    getBaseName(extension = '.ts') {
+        return `${this.options.fileName(this.nativeEnum.name)}${extension}`;
+    }
+}

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
 ```
@@ -381,6 +382,8 @@ See also the list of contributors who [participated](https://github.com/mikro-or
 
 Please ⭐️ this repository if this project helped you!
 
+> If you'd like to support my open-source work, consider sponsoring me directly at [github.com/sponsors/b4nan](https://github.com/sponsors/b4nan).
+
 ## 📝 License
 
 Copyright © 2018 [Martin Adámek](https://github.com/b4nan).

package/SourceFile.d.ts

@@ -4,14 +4,21 @@ 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;
     protected readonly options: GenerateOptions;
     protected readonly coreImports: Set<string>;
+    protected readonly decoratorImports: Set<string>;
     protected readonly entityImports: Set<string>;
+    protected readonly enumImports: Map<string, string[]>;
     constructor(meta: EntityMetadata, namingStrategy: NamingStrategy, platform: Platform, options: GenerateOptions);
     generate(): string;
+    /**
+     * Convert index column options to quoted output format.
+     */
+    private getColumnOptions;
     protected getIndexOptions(index: EntityMetadata['indexes'][number], isAtEntityLevel?: boolean): IndexOptions<Dictionary, string>;
     protected getUniqueOptions(index: EntityMetadata['uniques'][number], isAtEntityLevel?: boolean): UniqueOptions<Dictionary, string>;
     protected generateImports(): string;
@@ -28,13 +35,13 @@ 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): void;
+    protected getScalarPropertyDecoratorOptions(options: Dictionary, prop: EntityProperty, quote?: boolean): void;
     protected getManyToManyDecoratorOptions(options: Dictionary, prop: EntityProperty): void;
     protected getOneToManyDecoratorOptions(options: Dictionary, prop: EntityProperty): void;
     protected getEmbeddedPropertyDeclarationOptions(options: Dictionary, prop: EntityProperty): void;
     protected getForeignKeyDecoratorOptions(options: OneToOneOptions<any, any>, prop: EntityProperty): void;
     protected getDecoratorType(prop: EntityProperty): string;
     protected referenceCoreImport(identifier: string): string;
+    protected referenceDecoratorImport(identifier: string): string;
 }