@mikro-orm/entity-generator 7.0.2-dev.8 → 7.0.2

package/EntitySchemaSourceFile.d.ts

@@ -1,9 +1,9 @@
 import { type Dictionary, type EntityProperty } from '@mikro-orm/core';
 import { SourceFile } from './SourceFile.js';
 export declare class EntitySchemaSourceFile extends SourceFile {
-    generate(): string;
-    protected generateClassDefinition(): string;
-    protected getPropertyOptions(prop: EntityProperty, quote?: boolean): Dictionary;
-    protected getPropertyIndexesOptions(prop: EntityProperty, options: Dictionary): void;
-    protected getScalarPropertyDecoratorOptions(options: Dictionary, prop: EntityProperty, quote?: boolean): void;
+  generate(): string;
+  protected generateClassDefinition(): string;
+  protected getPropertyOptions(prop: EntityProperty, quote?: boolean): Dictionary;
+  protected getPropertyIndexesOptions(prop: EntityProperty, options: Dictionary): void;
+  protected getScalarPropertyDecoratorOptions(options: Dictionary, prop: EntityProperty, quote?: boolean): void;
 }

package/EntitySchemaSourceFile.js

@@ -1,151 +1,147 @@
-import { Config, ReferenceKind, } from '@mikro-orm/core';
+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;
+  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);
+        }
+      }
     }
-    generateClassDefinition() {
-        let classBody = '';
-        if (!this.options.customBaseEntityName || this.meta.className === this.options.customBaseEntityName) {
-            const defineConfigTypeSettings = {};
-            defineConfigTypeSettings.forceObject = this.platform.getConfig().get('serialization').forceObject ?? false;
-            if (defineConfigTypeSettings.forceObject) {
-                classBody += `${' '.repeat(2)}[${this.referenceCoreImport('Config')}]?: ${this.referenceCoreImport('DefineConfig')}<${this.serializeObject(defineConfigTypeSettings)}>;\n`;
-            }
-        }
-        const eagerProperties = [];
-        const primaryProps = [];
-        const props = [];
-        for (const prop of Object.values(this.meta.properties)) {
-            props.push(this.getPropertyDefinition(prop, 2));
-            if (prop.eager) {
-                eagerProperties.push(prop);
-            }
-            if (prop.primary && (!['id', '_id', 'uuid'].includes(prop.name) || this.meta.compositePK)) {
-                primaryProps.push(prop);
-            }
-        }
-        if (primaryProps.length > 0) {
-            const primaryPropNames = primaryProps.map(prop => `'${prop.name}'`);
-            if (primaryProps.length > 1) {
-                classBody += `${' '.repeat(2)}[${this.referenceCoreImport('PrimaryKeyProp')}]?: [${primaryPropNames.join(', ')}];\n`;
-            }
-            else {
-                classBody += `${' '.repeat(2)}[${this.referenceCoreImport('PrimaryKeyProp')}]?: ${primaryPropNames[0]};\n`;
-            }
-        }
-        if (eagerProperties.length > 0) {
-            const eagerPropertyNames = eagerProperties.map(prop => `'${prop.name}'`).sort();
-            classBody += `${' '.repeat(2)}[${this.referenceCoreImport('EagerProps')}]?: ${eagerPropertyNames.join(' | ')};\n`;
-        }
-        classBody += props.join('');
-        return this.getEntityClass(classBody);
+    let ret = classDefinition;
+    if (enumDefinitions.length) {
+      ret += '\n' + enumDefinitions.join('\n');
     }
-    getPropertyOptions(prop, quote = true) {
-        const options = {};
-        if (prop.primary) {
-            options.primary = true;
-        }
-        if (typeof prop.kind !== 'undefined' && prop.kind !== ReferenceKind.SCALAR) {
-            options.kind = this.quote(prop.kind);
-        }
-        if (prop.kind === ReferenceKind.MANY_TO_MANY) {
-            this.getManyToManyDecoratorOptions(options, prop);
-        }
-        else if (prop.kind === ReferenceKind.ONE_TO_MANY) {
-            this.getOneToManyDecoratorOptions(options, prop);
-        }
-        else if (prop.kind === ReferenceKind.SCALAR || typeof prop.kind === 'undefined') {
-            this.getScalarPropertyDecoratorOptions(options, prop, quote);
-        }
-        else if (prop.kind === ReferenceKind.EMBEDDED) {
-            this.getEmbeddedPropertyDeclarationOptions(options, prop);
-        }
-        else {
-            this.getForeignKeyDecoratorOptions(options, prop);
-        }
-        if (prop.formula) {
-            options.formula = `${prop.formula}`;
-        }
-        this.getCommonDecoratorOptions(options, prop);
-        this.getPropertyIndexesOptions(prop, options);
-        return options;
+    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));
     }
-    getPropertyIndexesOptions(prop, options) {
-        if (prop.kind === ReferenceKind.SCALAR) {
-            if (prop.index) {
-                options.index = this.quote(prop.index);
-            }
-            if (prop.unique) {
-                options.unique = this.quote(prop.unique);
-            }
-            return;
-        }
-        const processIndex = (type) => {
-            const propType = prop[type];
-            if (!propType) {
-                return;
-            }
-            const defaultName = this.platform.getIndexName(this.meta.collection, prop.fieldNames, type);
-            /* v8 ignore next */
-            options[type] = propType === true || defaultName === propType ? 'true' : this.quote(propType);
-            const expected = {
-                index: this.platform.indexForeignKeys(),
-                unique: prop.kind === ReferenceKind.ONE_TO_ONE,
-            };
-            if (expected[type] && options[type] === 'true') {
-                delete options[type];
-            }
-        };
-        processIndex('index');
-        processIndex('unique');
+    if (this.meta.uniques.length > 0) {
+      entitySchemaOptions.uniques = this.meta.uniques.map(index => this.getUniqueOptions(index));
     }
-    getScalarPropertyDecoratorOptions(options, prop, quote = true) {
-        if (prop.enum) {
-            options.enum = true;
-            options.items = `() => ${prop.runtimeType}`;
-        }
-        else {
-            options.type = quote ? this.quote(prop.type) : prop.type;
-        }
-        super.getScalarPropertyDecoratorOptions(options, prop, quote);
+    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.options.customBaseEntityName || this.meta.className === this.options.customBaseEntityName) {
+      const defineConfigTypeSettings = {};
+      defineConfigTypeSettings.forceObject = this.platform.getConfig().get('serialization').forceObject ?? false;
+      if (defineConfigTypeSettings.forceObject) {
+        classBody += `${' '.repeat(2)}[${this.referenceCoreImport('Config')}]?: ${this.referenceCoreImport('DefineConfig')}<${this.serializeObject(defineConfigTypeSettings)}>;\n`;
+      }
+    }
+    const eagerProperties = [];
+    const primaryProps = [];
+    const props = [];
+    for (const prop of Object.values(this.meta.properties)) {
+      props.push(this.getPropertyDefinition(prop, 2));
+      if (prop.eager) {
+        eagerProperties.push(prop);
+      }
+      if (prop.primary && (!['id', '_id', 'uuid'].includes(prop.name) || this.meta.compositePK)) {
+        primaryProps.push(prop);
+      }
+    }
+    if (primaryProps.length > 0) {
+      const primaryPropNames = primaryProps.map(prop => `'${prop.name}'`);
+      if (primaryProps.length > 1) {
+        classBody += `${' '.repeat(2)}[${this.referenceCoreImport('PrimaryKeyProp')}]?: [${primaryPropNames.join(', ')}];\n`;
+      } else {
+        classBody += `${' '.repeat(2)}[${this.referenceCoreImport('PrimaryKeyProp')}]?: ${primaryPropNames[0]};\n`;
+      }
+    }
+    if (eagerProperties.length > 0) {
+      const eagerPropertyNames = eagerProperties.map(prop => `'${prop.name}'`).sort();
+      classBody += `${' '.repeat(2)}[${this.referenceCoreImport('EagerProps')}]?: ${eagerPropertyNames.join(' | ')};\n`;
+    }
+    classBody += props.join('');
+    return this.getEntityClass(classBody);
+  }
+  getPropertyOptions(prop, quote = true) {
+    const options = {};
+    if (prop.primary) {
+      options.primary = true;
+    }
+    if (typeof prop.kind !== 'undefined' && prop.kind !== ReferenceKind.SCALAR) {
+      options.kind = this.quote(prop.kind);
+    }
+    if (prop.kind === ReferenceKind.MANY_TO_MANY) {
+      this.getManyToManyDecoratorOptions(options, prop);
+    } else if (prop.kind === ReferenceKind.ONE_TO_MANY) {
+      this.getOneToManyDecoratorOptions(options, prop);
+    } else if (prop.kind === ReferenceKind.SCALAR || typeof prop.kind === 'undefined') {
+      this.getScalarPropertyDecoratorOptions(options, prop, quote);
+    } else if (prop.kind === ReferenceKind.EMBEDDED) {
+      this.getEmbeddedPropertyDeclarationOptions(options, prop);
+    } else {
+      this.getForeignKeyDecoratorOptions(options, prop);
+    }
+    if (prop.formula) {
+      options.formula = `${prop.formula}`;
+    }
+    this.getCommonDecoratorOptions(options, prop);
+    this.getPropertyIndexesOptions(prop, options);
+    return options;
+  }
+  getPropertyIndexesOptions(prop, options) {
+    if (prop.kind === ReferenceKind.SCALAR) {
+      if (prop.index) {
+        options.index = this.quote(prop.index);
+      }
+      if (prop.unique) {
+        options.unique = this.quote(prop.unique);
+      }
+      return;
+    }
+    const processIndex = type => {
+      const propType = prop[type];
+      if (!propType) {
+        return;
+      }
+      const defaultName = this.platform.getIndexName(this.meta.collection, prop.fieldNames, type);
+      /* v8 ignore next */
+      options[type] = propType === true || defaultName === propType ? 'true' : this.quote(propType);
+      const expected = {
+        index: this.platform.indexForeignKeys(),
+        unique: prop.kind === ReferenceKind.ONE_TO_ONE,
+      };
+      if (expected[type] && options[type] === 'true') {
+        delete options[type];
+      }
+    };
+    processIndex('index');
+    processIndex('unique');
+  }
+  getScalarPropertyDecoratorOptions(options, prop, quote = true) {
+    if (prop.enum) {
+      options.enum = true;
+      options.items = `() => ${prop.runtimeType}`;
+    } else {
+      options.type = quote ? this.quote(prop.type) : prop.type;
     }
+    super.getScalarPropertyDecoratorOptions(options, prop, quote);
+  }
 }

package/NativeEnumSourceFile.d.ts

@@ -1,12 +1,18 @@
 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;
+  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

@@ -1,47 +1,49 @@
 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;
+  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`;
     }
-    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;
+    let ret = '';
+    if (enumMode === 'dictionary') {
+      ret += `export const ${enumClassName} = {\n`;
+    } else {
+      ret += `export enum ${enumClassName} {\n`;
     }
-    getBaseName(extension = '.ts') {
-        return `${this.options.fileName(this.nativeEnum.name)}${extension}`;
+    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}`;
+  }
 }