@mikro-orm/entity-generator 6.3.5-dev.2 → 6.3.5-dev.21

package/README.md

@@ -143,7 +143,7 @@ There is also auto-generated [CHANGELOG.md](CHANGELOG.md) file based on commit m
 - [Using `QueryBuilder`](https://mikro-orm.io/docs/query-builder)
 - [Preloading Deeply Nested Structures via populate](https://mikro-orm.io/docs/nested-populate)
 - [Property Validation](https://mikro-orm.io/docs/property-validation)
-- [Lifecycle Hooks](https://mikro-orm.io/docs/lifecycle-hooks)
+- [Lifecycle Hooks](https://mikro-orm.io/docs/events#hooks)
 - [Vanilla JS Support](https://mikro-orm.io/docs/usage-with-js)
 - [Schema Generator](https://mikro-orm.io/docs/schema-generator)
 - [Entity Generator](https://mikro-orm.io/docs/entity-generator)
@@ -163,6 +163,7 @@ You can find example integrations for some popular frameworks in the [`mikro-orm
 - [NextJS + MySQL](https://github.com/jonahallibone/mikro-orm-nextjs)
 - [Accounts.js REST and GraphQL authentication + SQLite](https://github.com/darkbasic/mikro-orm-accounts-example)
 - [Nest + Shopify + PostgreSQL + GraphQL](https://github.com/Cloudshelf/Shopify_CSConnector)
+- [Elysia.js + libSQL + Bun](https://github.com/mikro-orm/elysia-bun-example-app)
 
 ### JavaScript Examples 
 

package/SourceFile.d.ts

@@ -12,8 +12,8 @@ export declare class SourceFile {
     protected readonly entityImports: Set<string>;
     constructor(meta: EntityMetadata, namingStrategy: NamingStrategy, platform: Platform, options: GenerateOptions);
     generate(): string;
-    protected getIndexOptions(index: EntityMetadata['indexes'][number]): IndexOptions<Dictionary>;
-    protected getUniqueOptions(index: EntityMetadata['uniques'][number]): UniqueOptions<Dictionary>;
+    protected getIndexOptions(index: EntityMetadata['indexes'][number], isAtEntityLevel?: boolean): IndexOptions<Dictionary>;
+    protected getUniqueOptions(index: EntityMetadata['uniques'][number], isAtEntityLevel?: boolean): UniqueOptions<Dictionary>;
     protected generateImports(): string;
     protected getEntityClass(classBody: string): string;
     getBaseName(extension?: string): string;
@@ -28,6 +28,8 @@ 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 getManyToManyDecoratorOptions(options: Dictionary, prop: EntityProperty): void;
     protected getOneToManyDecoratorOptions(options: Dictionary, prop: EntityProperty): void;

package/SourceFile.js

@@ -34,12 +34,18 @@ class SourceFile {
                 ret += `@${this.referenceCoreImport('Entity')}(${core_1.Utils.hasObjectKeys(options) ? this.serializeObject(options) : ''})\n`;
             }
         }
-        this.meta.indexes.forEach(index => {
+        for (const index of this.meta.indexes) {
+            if (index.properties?.length === 1 && typeof this.meta.properties[index.properties[0]] !== 'undefined') {
+                continue;
+            }
             ret += `@${this.referenceCoreImport('Index')}(${this.serializeObject(this.getIndexOptions(index))})\n`;
-        });
-        this.meta.uniques.forEach(index => {
+        }
+        for (const index of this.meta.uniques) {
+            if (index.properties?.length === 1 && typeof this.meta.properties[index.properties[0]] !== 'undefined') {
+                continue;
+            }
             ret += `@${this.referenceCoreImport('Unique')}(${this.serializeObject(this.getUniqueOptions(index))})\n`;
-        });
+        }
         let classHead = '';
         if (this.meta.className === this.options.customBaseEntityName) {
             const defineConfigTypeSettings = {};
@@ -90,7 +96,7 @@ class SourceFile {
         }
         return ret;
     }
-    getIndexOptions(index) {
+    getIndexOptions(index, isAtEntityLevel = true) {
         const indexOpt = {};
         if (typeof index.name === 'string') {
             indexOpt.name = this.quote(index.name);
@@ -98,12 +104,12 @@ class SourceFile {
         if (index.expression) {
             indexOpt.expression = this.quote(index.expression);
         }
-        if (index.properties) {
+        if (isAtEntityLevel && index.properties) {
             indexOpt.properties = core_1.Utils.asArray(index.properties).map(prop => this.quote('' + prop));
         }
         return indexOpt;
     }
-    getUniqueOptions(index) {
+    getUniqueOptions(index, isAtEntityLevel = true) {
         const uniqueOpt = {};
         if (typeof index.name === 'string') {
             uniqueOpt.name = this.quote(index.name);
@@ -111,9 +117,12 @@ class SourceFile {
         if (index.expression) {
             uniqueOpt.expression = this.quote(index.expression);
         }
-        if (index.properties) {
+        if (isAtEntityLevel && index.properties) {
             uniqueOpt.properties = core_1.Utils.asArray(index.properties).map(prop => this.quote('' + prop));
         }
+        if (index.deferMode) {
+            uniqueOpt.deferMode = `${this.referenceCoreImport('DeferMode')}.INITIALLY_${index.deferMode.toUpperCase()}`;
+        }
         return uniqueOpt;
     }
     generateImports() {
@@ -206,31 +215,16 @@ class SourceFile {
                     if (prop.enum) {
                         return prop.runtimeType;
                     }
-                    const mappedDeclaredType = this.platform.getMappedType(prop.type);
-                    const mappedRawType = (prop.customTypes?.[0] ?? ((prop.type !== 'unknown' && mappedDeclaredType instanceof core_1.UnknownType)
-                        ? this.platform.getMappedType(prop.columnTypes[0])
-                        : mappedDeclaredType));
-                    const rawType = mappedRawType.runtimeType;
-                    const serializedType = (prop.customType ?? mappedRawType).runtimeType;
-                    // Add non-lib imports where needed.
-                    for (const typeSpec of [prop.runtimeType, rawType, serializedType]) {
-                        const simplePropType = typeSpec.replace(/\[]+$/, '');
-                        if (!primitivesAndLibs.includes(simplePropType)) {
-                            this.entityImports.add(simplePropType);
-                        }
-                    }
-                    if (prop.runtimeType !== rawType || rawType !== serializedType) {
+                    const breakdownOfIType = this.breakdownOfIType(prop);
+                    if (typeof breakdownOfIType !== 'undefined') {
                         hasITypeWrapper = true;
-                        if (rawType !== serializedType) {
-                            return `${this.referenceCoreImport('IType')}<${prop.runtimeType}, ${rawType}, ${serializedType}>`;
-                        }
-                        return `${this.referenceCoreImport('IType')}<${prop.runtimeType}, ${rawType}>`;
+                        return `${this.referenceCoreImport('IType')}<${breakdownOfIType.join(', ')}>`;
                     }
                     return prop.runtimeType;
                 }
                 return prop.type;
             })();
-        const useDefault = prop.default != null;
+        const useDefault = prop.default != null && (propType !== 'unknown');
         const optional = prop.nullable ? '?' : (useDefault ? '' : '!');
         let ret = `${propName}${optional}: ${prop.ref ? `${this.referenceCoreImport('Ref')}<${propType}>` : `${(this.options.esmImport && !isScalar) ? `${this.referenceCoreImport('Rel')}<${propType}>` : propType}`}`;
         if (prop.array && (prop.kind === core_1.ReferenceKind.EMBEDDED || prop.enum)) {
@@ -240,7 +234,7 @@ class SourceFile {
         if (useDefault || (prop.optional && !prop.nullable)) {
             ret += ` & ${this.referenceCoreImport('Opt')}`;
         }
-        if (!useDefault || hasITypeWrapper) {
+        if (!useDefault || hasITypeWrapper || prop.type === 'unknown') {
             return `${padding}${ret};\n`;
         }
         if (prop.enum && typeof prop.default === 'string') {
@@ -375,16 +369,6 @@ class SourceFile {
         return `${decorator}(${decoratorArgs.join(', ')})\n`;
     }
     getPropertyIndexes(prop, options) {
-        if (prop.kind === core_1.ReferenceKind.SCALAR) {
-            const ret = [];
-            if (prop.index) {
-                ret.push(`@${this.referenceCoreImport('Index')}(${typeof prop.index === 'string' ? `{ name: ${this.quote(prop.index)} }` : ''})`);
-            }
-            if (prop.unique) {
-                ret.push(`@${this.referenceCoreImport('Unique')}(${typeof prop.unique === 'string' ? `{ name: ${this.quote(prop.unique)} }` : ''})`);
-            }
-            return ret;
-        }
         const processIndex = (type) => {
             const propType = prop[type];
             if (!propType) {
@@ -402,7 +386,32 @@ class SourceFile {
         };
         processIndex('index');
         processIndex('unique');
-        return [];
+        const ret = [];
+        let propIndexIsNonTrivialIndex = false;
+        const nonTrivialIndexes = this.meta.indexes.filter(i => i.properties?.length === 1 && i.properties[0] === prop.name);
+        for (const i of nonTrivialIndexes) {
+            ret.push(`@${this.referenceCoreImport('Index')}(${this.serializeObject(this.getIndexOptions(i, false))})`);
+            if (prop.index === i.name) {
+                propIndexIsNonTrivialIndex = true;
+                delete options.index;
+            }
+        }
+        if (prop.index && !options.index && !propIndexIsNonTrivialIndex) {
+            ret.push(`@${this.referenceCoreImport('Index')}(${typeof prop.index === 'string' ? `{ name: ${this.quote(prop.index)} }` : ''})`);
+        }
+        let propIndexIsNonTrivialUnique = false;
+        const nonTrivialUnique = this.meta.uniques.filter(i => i.properties?.length === 1 && i.properties[0] === prop.name);
+        for (const i of nonTrivialUnique) {
+            ret.push(`@${this.referenceCoreImport('Unique')}(${this.serializeObject(this.getUniqueOptions(i, false))})`);
+            if (prop.unique === i.name) {
+                propIndexIsNonTrivialUnique = true;
+                delete options.unique;
+            }
+        }
+        if (prop.unique && !options.unique && !propIndexIsNonTrivialUnique) {
+            ret.push(`@${this.referenceCoreImport('Unique')}(${typeof prop.unique === 'string' ? `{ name: ${this.quote(prop.unique)} }` : ''})`);
+        }
+        return ret;
     }
     getCommonDecoratorOptions(options, prop) {
         if (prop.nullable && !prop.mappedBy) {
@@ -432,26 +441,59 @@ class SourceFile {
         if (typeof prop.comment === 'string') {
             options.comment = this.quote(prop.comment);
         }
-        if (typeof prop.fieldNames !== 'undefined' && prop.fieldNames.length > 1) {
-            // TODO: Composite FKs with default values require additions to default/defaultRaw that are not yet supported.
-            return;
+        // TODO: Composite FKs with default values require additions to default/defaultRaw that are not yet supported.
+        if (prop.fieldNames?.length <= 1) {
+            if (typeof prop.defaultRaw !== 'undefined' && prop.defaultRaw !== 'null' &&
+                prop.defaultRaw !== (typeof prop.default === 'string' ? this.quote(prop.default) : `${prop.default}`)) {
+                options.defaultRaw = `\`${prop.defaultRaw}\``;
+            }
+            else if (prop.default != null && (prop.ref || (!prop.enum && (typeof prop.kind === 'undefined' || prop.kind === core_1.ReferenceKind.SCALAR) && (prop.type === 'unknown' || typeof this.breakdownOfIType(prop) !== 'undefined')))) {
+                options.default = typeof prop.default === 'string' ? this.quote(prop.default) : prop.default;
+            }
         }
-        if (typeof prop.defaultRaw !== 'undefined' && prop.defaultRaw !== 'null' &&
-            prop.defaultRaw !== (typeof prop.default === 'string' ? this.quote(prop.default) : `${prop.default}`)) {
-            options.defaultRaw = `\`${prop.defaultRaw}\``;
-        }
-        else if (prop.default != null && (prop.ref || (!prop.enum && (typeof prop.kind === 'undefined' || prop.kind === core_1.ReferenceKind.SCALAR) && (() => {
-            const mappedDeclaredType = this.platform.getMappedType(prop.type);
-            const mappedRawType = (prop.customTypes?.[0] ?? ((prop.type !== 'unknown' && mappedDeclaredType instanceof core_1.UnknownType)
-                ? this.platform.getMappedType(prop.columnTypes[0])
-                : mappedDeclaredType));
-            const rawType = mappedRawType.runtimeType;
-            const serializedType = (prop.customType ?? mappedRawType).runtimeType;
-            return prop.runtimeType !== rawType || rawType !== serializedType;
-        })()))) {
-            options.default = typeof prop.default === 'string' ? this.quote(prop.default) : prop.default;
+        if (typeof prop.extra === 'string') {
+            options.extra = this.quote(prop.extra);
+        }
+        if (prop.deferMode) {
+            options.deferMode = `${this.referenceCoreImport('DeferMode')}.INITIALLY_${prop.deferMode.toUpperCase()}`;
+        }
+        if (typeof prop.ignoreSchemaChanges !== 'undefined') {
+            options.ignoreSchemaChanges ??= [];
+            options.ignoreSchemaChanges.push(...prop.ignoreSchemaChanges.map(v => this.quote(v)));
         }
     }
+    propTypeBreakdowns = new WeakMap();
+    breakdownOfIType(prop) {
+        if (this.propTypeBreakdowns.has(prop)) {
+            return this.propTypeBreakdowns.get(prop);
+        }
+        const mappedDeclaredType = this.platform.getMappedType(prop.type);
+        const mappedRawType = (prop.customTypes?.[0] ?? ((prop.type !== 'unknown' && mappedDeclaredType instanceof core_1.UnknownType)
+            ? this.platform.getMappedType(prop.columnTypes[0])
+            : mappedDeclaredType));
+        const rawType = mappedRawType.runtimeType;
+        const serializedType = (prop.customType ?? mappedRawType).runtimeType;
+        // Add non-lib imports where needed.
+        for (const typeSpec of [prop.runtimeType, rawType, serializedType]) {
+            const simplePropType = typeSpec.replace(/\[]+$/, '');
+            if (!primitivesAndLibs.includes(simplePropType)) {
+                this.entityImports.add(simplePropType);
+            }
+        }
+        if (prop.runtimeType !== rawType || rawType !== serializedType) {
+            if (rawType !== serializedType) {
+                const r = [prop.runtimeType, rawType, serializedType];
+                this.propTypeBreakdowns.set(prop, r);
+                return r;
+            }
+            const r = [prop.runtimeType, rawType];
+            this.propTypeBreakdowns.set(prop, r);
+            return r;
+        }
+        const r = undefined;
+        this.propTypeBreakdowns.set(prop, r);
+        return r;
+    }
     getScalarPropertyDecoratorOptions(options, prop) {
         if (prop.fieldNames[0] !== this.namingStrategy.propertyToColumnName(prop.name)) {
             options.fieldName = this.quote(prop.fieldNames[0]);
@@ -486,11 +528,17 @@ class SourceFile {
         const columnTypeFromMappedRuntimeType = mappedRuntimeType.getColumnType({ ...prop, autoincrement: false }, this.platform);
         const columnTypeFromMappedColumnType = mappedColumnType.getColumnType({ ...prop, autoincrement: false }, this.platform);
         const columnTypeFromMappedDeclaredType = mappedDeclaredType.getColumnType({ ...prop, autoincrement: false }, this.platform);
-        if (isTypeStringMissingFromMap
-            || columnTypeFromMappedRuntimeType !== columnTypeFromMappedColumnType
-            || columnTypeFromMappedDeclaredType !== columnTypeFromMappedColumnType
-            || [mappedRuntimeType, mappedColumnType, columnTypeFromMappedDeclaredType].some(t => t instanceof core_1.UnknownType)) {
-            options.columnType = this.quote(columnTypeFromMappedColumnType);
+        const needsExplicitColumnType = () => {
+            if (isTypeStringMissingFromMap || [mappedRuntimeType, mappedColumnType, columnTypeFromMappedDeclaredType].some(t => t instanceof core_1.UnknownType)) {
+                return true;
+            }
+            if (this.platform.normalizeColumnType(prop.columnTypes[0], prop) !== this.platform.normalizeColumnType(columnTypeFromMappedColumnType, prop)) {
+                return prop.columnTypes[0] !== columnTypeFromMappedColumnType;
+            }
+            return columnTypeFromMappedRuntimeType !== columnTypeFromMappedColumnType || columnTypeFromMappedDeclaredType !== columnTypeFromMappedColumnType;
+        };
+        if (needsExplicitColumnType()) {
+            options.columnType = this.quote(prop.columnTypes[0]);
         }
         const assign = (key) => {
             if (prop[key] != null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/entity-generator",
-  "version": "6.3.5-dev.2",
+  "version": "6.3.5-dev.21",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "index.js",
   "module": "index.mjs",
@@ -58,13 +58,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@mikro-orm/knex": "6.3.5-dev.2",
+    "@mikro-orm/knex": "6.3.5-dev.21",
     "fs-extra": "11.2.0"
   },
   "devDependencies": {
     "@mikro-orm/core": "^6.3.4"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "6.3.5-dev.2"
+    "@mikro-orm/core": "6.3.5-dev.21"
   }
 }