@mikro-orm/entity-generator 7.1.0-dev.3 → 7.1.0-dev.31

package/README.md

@@ -2,7 +2,7 @@
   <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, SQLite (including libSQL), MSSQL and Oracle 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 (including CockroachDB and PGlite), SQLite (including libSQL), MSSQL and Oracle databases.
 
 > Heavily inspired by [Doctrine](https://www.doctrine-project.org/) and [Hibernate](https://hibernate.org/).
 
@@ -19,6 +19,7 @@ Install a driver package for your database:
 
 ```sh
 npm install @mikro-orm/postgresql   # PostgreSQL
+npm install @mikro-orm/pglite       # PGlite (embedded PostgreSQL in WASM)
 npm install @mikro-orm/mysql        # MySQL
 npm install @mikro-orm/mariadb      # MariaDB
 npm install @mikro-orm/sqlite       # SQLite

package/SourceFile.d.ts

@@ -1,4 +1,4 @@
-import { type Dictionary, type EmbeddableOptions, type EntityMetadata, type EntityOptions, type EntityProperty, type GenerateOptions, type IndexOptions, type NamingStrategy, type OneToOneOptions, type Platform, type UniqueOptions } from '@mikro-orm/core';
+import { type Dictionary, type EmbeddableOptions, type EntityMetadata, type EntityOptions, type EntityPartitionBy, type EntityProperty, type GenerateOptions, type IndexOptions, type NamingStrategy, type OneToOneOptions, type Platform, type UniqueOptions } from '@mikro-orm/core';
 /**
  * @see https://github.com/tc39/proposal-regexp-unicode-property-escapes#other-examples
  */
@@ -30,6 +30,7 @@ export declare class SourceFile {
     protected serializeObject(options: {}, wordwrap?: number, spaces?: number, level?: number): string;
     protected serializeValue(val: unknown, wordwrap?: number, spaces?: number, level?: number): unknown;
     protected getEntityDeclOptions(): EntityOptions<unknown>;
+    protected getPartitionByDecl(partitionBy: EntityPartitionBy): Dictionary;
     protected getEmbeddableDeclOptions(): EmbeddableOptions<unknown>;
     private getCollectionDecl;
     private getPropertyDecorator;

package/SourceFile.js

@@ -130,6 +130,9 @@ export class SourceFile {
         else if (typeof index.expression === 'function') {
             indexOpt.expression = `${index.expression}`.replace(')=>`', ') => `');
         }
+        if (typeof index.where === 'string') {
+            indexOpt.where = this.quote(index.where);
+        }
         if (isAtEntityLevel && index.properties) {
             indexOpt.properties = Utils.asArray(index.properties).map(prop => this.quote('' + prop));
         }
@@ -170,6 +173,9 @@ export class SourceFile {
         else if (typeof index.expression === 'function') {
             uniqueOpt.expression = `${index.expression}`.replace(')=>`', ') => `');
         }
+        if (typeof index.where === 'string') {
+            uniqueOpt.where = this.quote(index.where);
+        }
         if (isAtEntityLevel && index.properties) {
             uniqueOpt.properties = Utils.asArray(index.properties).map(prop => this.quote('' + prop));
         }
@@ -397,8 +403,11 @@ export class SourceFile {
         const enumTypeName = this.namingStrategy.getEnumTypeName(prop.fieldNames[0], this.meta.collection, this.meta.schema);
         const padding = ' '.repeat(padLeft);
         const enumValues = prop.items;
+        // numeric enums arrive as strings; emit raw numbers so the generated TS reads `Foo: 1` not `Foo: '1'`
+        const allNumeric = enumValues.length > 0 && enumValues.every(item => /^-?\d+$/.test(item));
+        const formatValue = (item) => (allNumeric ? item : this.quote(item));
         if (enumMode === 'union-type') {
-            return `export type ${enumTypeName} = ${enumValues.map(item => this.quote(item)).join(' | ')};\n`;
+            return `export type ${enumTypeName} = ${enumValues.map(formatValue).join(' | ')};\n`;
         }
         let ret = '';
         if (enumMode === 'dictionary') {
@@ -410,10 +419,10 @@ export class SourceFile {
         for (const enumValue of enumValues) {
             const enumName = this.namingStrategy.enumValueToEnumProperty(enumValue, prop.fieldNames[0], this.meta.collection, this.meta.schema);
             if (enumMode === 'dictionary') {
-                ret += `${padding}${identifierRegex.test(enumName) ? enumName : this.quote(enumName)}: ${this.quote(enumValue)},\n`;
+                ret += `${padding}${identifierRegex.test(enumName) ? enumName : this.quote(enumName)}: ${formatValue(enumValue)},\n`;
             }
             else {
-                ret += `${padding}${identifierRegex.test(enumName) ? enumName : this.quote(enumName)} = ${this.quote(enumValue)},\n`;
+                ret += `${padding}${identifierRegex.test(enumName) ? enumName : this.quote(enumName)} = ${formatValue(enumValue)},\n`;
             }
         }
         if (enumMode === 'dictionary') {
@@ -475,6 +484,9 @@ export class SourceFile {
         if (this.meta.comment) {
             options.comment = this.quote(this.meta.comment);
         }
+        if (this.meta.partitionBy) {
+            options.partitionBy = this.getPartitionByDecl(this.meta.partitionBy);
+        }
         if (this.meta.readonly && !this.meta.virtual) {
             options.readonly = this.meta.readonly;
         }
@@ -483,6 +495,40 @@ export class SourceFile {
         }
         return this.getCollectionDecl(options);
     }
+    getPartitionByDecl(partitionBy) {
+        const result = { type: this.quote(partitionBy.type) };
+        // Introspected metadata from `toEntityPartitionBy` always emits a string or string[];
+        // callback-form expressions only exist in hand-written entity metadata. Fail loud if a
+        // callback ever reaches the generator — stringifying `fn.toString()` would produce source
+        // that re-imports nothing and will not compile.
+        if (typeof partitionBy.expression === 'function') {
+            throw new Error(`Cannot emit entity source for ${this.meta.className}: partitionBy.expression is a callback. ` +
+                `Entity generator expects string or string[] expressions from catalog introspection.`);
+        }
+        const expression = partitionBy.expression;
+        if (Array.isArray(expression)) {
+            result.expression = expression.map(key => this.quote(String(key)));
+        }
+        else {
+            result.expression = this.quote(String(expression));
+        }
+        if (partitionBy.type === 'hash') {
+            result.partitions = Array.isArray(partitionBy.partitions)
+                ? partitionBy.partitions.map(name => this.quote(String(name)))
+                : partitionBy.partitions;
+        }
+        else {
+            result.partitions = partitionBy.partitions.map(partition => {
+                const entry = {};
+                if (partition.name) {
+                    entry.name = this.quote(partition.name);
+                }
+                entry.values = this.quote(partition.values);
+                return entry;
+            });
+        }
+        return result;
+    }
     getEmbeddableDeclOptions() {
         const options = {};
         const result = this.getCollectionDecl(options);
@@ -615,6 +661,9 @@ export class SourceFile {
         if (typeof prop.comment === 'string') {
             options.comment = this.quote(prop.comment);
         }
+        if (typeof prop.collation === 'string') {
+            options.collation = this.quote(prop.collation);
+        }
         // 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' &&
@@ -708,7 +757,9 @@ export class SourceFile {
         }
         if (prop.enum) {
             if (this.options.enumMode === 'union-type') {
-                options.items = `[${prop.items.map(item => this.quote(item)).join(', ')}]`;
+                const items = prop.items;
+                const allNumeric = items.length > 0 && items.every(item => /^-?\d+$/.test(item));
+                options.items = `[${items.map(item => (allNumeric ? item : this.quote(item))).join(', ')}]`;
             }
             else if (prop.nativeEnumName) {
                 const enumClassName = this.namingStrategy.getEnumClassName(prop.nativeEnumName, undefined, this.meta.schema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/entity-generator",
-  "version": "7.1.0-dev.3",
+  "version": "7.1.0-dev.31",
   "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.",
   "keywords": [
     "data-mapper",
@@ -47,13 +47,13 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.1.0-dev.3"
+    "@mikro-orm/sql": "7.1.0-dev.31"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^7.0.11"
+    "@mikro-orm/core": "^7.0.15"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.0-dev.3"
+    "@mikro-orm/core": "7.1.0-dev.31"
   },
   "engines": {
     "node": ">= 22.17.0"