@mikro-orm/reflection 7.0.0-dev.9 → 7.0.0-dev.91

package/README.md

@@ -11,7 +11,6 @@ TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-or
 [![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)
 [![Coverage Status](https://img.shields.io/coveralls/mikro-orm/mikro-orm.svg)](https://coveralls.io/r/mikro-orm/mikro-orm?branch=master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/27999651d3adc47cfa40/maintainability)](https://codeclimate.com/github/mikro-orm/mikro-orm/maintainability)
 [![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)
 
 ## 🤔 Unit of What?
@@ -141,7 +140,7 @@ There is also auto-generated [CHANGELOG.md](CHANGELOG.md) file based on commit m
 - [Composite and Foreign Keys as Primary Key](https://mikro-orm.io/docs/composite-keys)
 - [Filters](https://mikro-orm.io/docs/filters)
 - [Using `QueryBuilder`](https://mikro-orm.io/docs/query-builder)
-- [Preloading Deeply Nested Structures via populate](https://mikro-orm.io/docs/nested-populate)
+- [Populating relations](https://mikro-orm.io/docs/populating-relations)
 - [Property Validation](https://mikro-orm.io/docs/property-validation)
 - [Lifecycle Hooks](https://mikro-orm.io/docs/events#hooks)
 - [Vanilla JS Support](https://mikro-orm.io/docs/usage-with-js)
@@ -382,6 +381,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/TsMorphMetadataProvider.d.ts

@@ -1,10 +1,11 @@
 import { type SourceFile } from 'ts-morph';
-import { MetadataProvider, type EntityMetadata } from '@mikro-orm/core';
+import { type EntityMetadata, MetadataProvider } from '@mikro-orm/core';
 export declare class TsMorphMetadataProvider extends MetadataProvider {
     private project;
     private sources;
+    static useCache(): boolean;
     useCache(): boolean;
-    loadEntityMetadata(meta: EntityMetadata, name: string): void;
+    loadEntityMetadata(meta: EntityMetadata): void;
     getExistingSourceFile(path: string, ext?: string, validate?: boolean): SourceFile;
     protected initProperties(meta: EntityMetadata): void;
     private extractType;
@@ -12,7 +13,11 @@ export declare class TsMorphMetadataProvider extends MetadataProvider {
     private initPropertyType;
     private readTypeFromSource;
     private getSourceFile;
+    private stripRelativePath;
     private processWrapper;
     private initProject;
     private initSourceFiles;
+    loadFromCache(meta: EntityMetadata, cache: EntityMetadata): void;
+    saveToCache(meta: EntityMetadata): void;
+    getCacheKey(meta: Pick<EntityMetadata, 'className' | 'path'>): string;
 }

package/TsMorphMetadataProvider.js

@@ -1,12 +1,16 @@
-import { ModuleKind, Project } from 'ts-morph';
-import { MetadataError, MetadataProvider, MetadataStorage, ReferenceKind, Utils, ConfigurationLoader, } from '@mikro-orm/core';
+import { extname } from 'node:path';
+import { ComputedPropertyName, ModuleKind, NoSubstitutionTemplateLiteral, Project, StringLiteral } from 'ts-morph';
+import { MetadataError, MetadataProvider, MetadataStorage, RawQueryFragment, ReferenceKind, Type, Utils, } from '@mikro-orm/core';
 export class TsMorphMetadataProvider extends MetadataProvider {
     project;
     sources;
+    static useCache() {
+        return true;
+    }
     useCache() {
-        return this.config.get('metadataCache').enabled ?? true;
+        return this.config.get('metadataCache').enabled ?? TsMorphMetadataProvider.useCache();
     }
-    loadEntityMetadata(meta, name) {
+    loadEntityMetadata(meta) {
         if (!meta.path) {
             return;
         }
@@ -23,14 +27,12 @@ export class TsMorphMetadataProvider extends MetadataProvider {
         // load types and column names
         for (const prop of Object.values(meta.properties)) {
             const type = this.extractType(prop);
-            if (!type || this.config.get('discovery').alwaysAnalyseProperties) {
-                this.initPropertyType(meta, prop);
-            }
-            prop.type = type || prop.type;
+            this.initPropertyType(meta, prop);
+            prop.type = type ?? prop.type;
         }
     }
     extractType(prop) {
-        if (Utils.isString(prop.entity)) {
+        if (typeof prop.entity === 'string') {
             return prop.entity;
         }
         if (prop.entity) {
@@ -39,12 +41,11 @@ export class TsMorphMetadataProvider extends MetadataProvider {
         return prop.type;
     }
     cleanUpTypeTags(type) {
-        const genericTags = [/Opt<(.*?)>/, /Hidden<(.*?)>/];
+        const genericTags = [/Opt<(.*?)>/, /Hidden<(.*?)>/, /RequiredNullable<(.*?)>/];
         const intersectionTags = [
-            '{ [__optional]?: 1 | undefined; }',
-            '{ [__optional]?: 1; }',
-            '{ [__hidden]?: 1 | undefined; }',
-            '{ [__hidden]?: 1; }',
+            'Opt.Brand',
+            'Hidden.Brand',
+            'RequiredNullable.Brand',
         ];
         for (const tag of genericTags) {
             type = type.replace(tag, '$1');
@@ -57,17 +58,17 @@ export class TsMorphMetadataProvider extends MetadataProvider {
     }
     initPropertyType(meta, prop) {
         const { type: typeRaw, optional } = this.readTypeFromSource(meta, prop);
-        const type = this.cleanUpTypeTags(typeRaw);
-        prop.type = type;
-        prop.runtimeType = type;
+        prop.type = this.cleanUpTypeTags(typeRaw);
         if (optional) {
             prop.optional = true;
         }
         this.processWrapper(prop, 'Ref');
         this.processWrapper(prop, 'Reference');
+        this.processWrapper(prop, 'EntityRef');
+        this.processWrapper(prop, 'ScalarRef');
         this.processWrapper(prop, 'ScalarReference');
-        this.processWrapper(prop, 'Ref');
         this.processWrapper(prop, 'Collection');
+        prop.runtimeType ??= prop.type;
         if (prop.type.replace(/import\(.*\)\./g, '').match(/^(Dictionary|Record)<.*>$/)) {
             prop.type = 'json';
         }
@@ -75,12 +76,27 @@ export class TsMorphMetadataProvider extends MetadataProvider {
     readTypeFromSource(meta, prop) {
         const source = this.getExistingSourceFile(meta.path);
         const cls = source.getClass(meta.className);
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (!cls) {
             throw new MetadataError(`Source class for entity ${meta.className} not found. Verify you have 'compilerOptions.declaration' enabled in your 'tsconfig.json'. If you are using webpack, see https://bit.ly/35pPDNn`);
         }
         const properties = cls.getInstanceProperties();
-        const property = properties.find(v => v.getName() === prop.name);
+        const property = properties.find(v => {
+            if (v.getName() === prop.name) {
+                return true;
+            }
+            const nameNode = v.getNameNode();
+            if (nameNode instanceof StringLiteral && nameNode.getLiteralText() === prop.name) {
+                return true;
+            }
+            if (nameNode instanceof ComputedPropertyName) {
+                const expr = nameNode.getExpression();
+                if (expr instanceof NoSubstitutionTemplateLiteral && expr.getLiteralText() === prop.name) {
+                    return true;
+                }
+            }
+            return false;
+        });
         if (!property) {
             return { type: prop.type, optional: prop.nullable };
         }
@@ -91,7 +107,7 @@ export class TsMorphMetadataProvider extends MetadataProvider {
         }
         if (tsType.isArray()) {
             prop.array = true;
-            /* v8 ignore next 3 */
+            /* v8 ignore next */
             if (tsType.getArrayElementType().isEnum()) {
                 prop.items = tsType.getArrayElementType().getUnionTypes().map(t => t.getLiteralValueOrThrow());
             }
@@ -121,17 +137,21 @@ export class TsMorphMetadataProvider extends MetadataProvider {
         const baseDir = this.config.get('baseDir');
         const outDir = this.project.getCompilerOptions().outDir;
         let path = tsPath;
+        /* v8 ignore next */
         if (outDir != null) {
             const outDirRelative = Utils.relativePath(outDir, baseDir);
             path = path.replace(new RegExp(`^${outDirRelative}`), '');
         }
-        path = Utils.stripRelativePath(path);
+        path = this.stripRelativePath(path);
         const source = this.sources.find(s => s.getFilePath().endsWith(path));
         if (!source && validate) {
             throw new MetadataError(`Source file '${tsPath}' not found. Check your 'entitiesTs' option and verify you have 'compilerOptions.declaration' enabled in your 'tsconfig.json'. If you are using webpack, see https://bit.ly/35pPDNn`);
         }
         return source;
     }
+    stripRelativePath(str) {
+        return str.replace(/^(?:\.\.\/|\.\/)+/, '/');
+    }
     processWrapper(prop, wrapper) {
         // type can be sometimes in form of:
         // `'({ object?: Entity | undefined; } & import("...").Reference<Entity>)'`
@@ -146,21 +166,20 @@ export class TsMorphMetadataProvider extends MetadataProvider {
             return;
         }
         prop.type = m[1];
-        if (['Ref', 'Reference', 'Ref'].includes(wrapper)) {
+        if (['Ref', 'Reference', 'EntityRef', 'ScalarRef', 'ScalarReference'].includes(wrapper)) {
             prop.ref = true;
         }
     }
     initProject() {
-        const settings = ConfigurationLoader.getSettings();
         /* v8 ignore next */
-        const tsConfigFilePath = this.config.get('discovery').tsConfigPath ?? settings.tsConfigPath ?? './tsconfig.json';
+        const tsConfigFilePath = this.config.get('discovery').tsConfigPath ?? './tsconfig.json';
         try {
             this.project = new Project({
                 tsConfigFilePath: Utils.normalizePath(process.cwd(), tsConfigFilePath),
                 skipAddingFilesFromTsConfig: true,
                 compilerOptions: {
                     strictNullChecks: true,
-                    module: ModuleKind.Node16,
+                    module: ModuleKind.Node20,
                 },
             });
         }
@@ -169,22 +188,20 @@ export class TsMorphMetadataProvider extends MetadataProvider {
             this.project = new Project({
                 compilerOptions: {
                     strictNullChecks: true,
-                    module: ModuleKind.Node16,
+                    module: ModuleKind.Node20,
                 },
             });
         }
     }
     initSourceFiles() {
-        if (!this.project) {
-            this.initProject();
-        }
+        this.initProject();
         this.sources = [];
         // All entity files are first required during the discovery, before we reach here, so it is safe to get the parts from the global
         // metadata storage. We know the path thanks to the decorators being executed. In case we are running the TS code, the extension
         // will be already `.ts`, so no change is needed. `.js` files will get renamed to `.d.ts` files as they will be used as a source for
         // the ts-morph reflection.
         for (const meta of Utils.values(MetadataStorage.getMetadata())) {
-            /* v8 ignore next 3 */
+            /* v8 ignore next */
             const path = meta.path.match(/\.[jt]s$/)
                 ? meta.path.replace(/\.js$/, '.d.ts')
                 : `${meta.path}.d.ts`; // when entities are bundled, their paths are just their names
@@ -194,4 +211,47 @@ export class TsMorphMetadataProvider extends MetadataProvider {
             }
         }
     }
+    loadFromCache(meta, cache) {
+        Object.values(cache.properties).forEach(prop => {
+            const metaProp = meta.properties[prop.name];
+            /* v8 ignore next 3 */
+            if (metaProp?.enum && Array.isArray(metaProp.items)) {
+                delete prop.items;
+            }
+        });
+        Utils.mergeConfig(meta, cache);
+    }
+    saveToCache(meta) {
+        if (!this.useCache()) {
+            return;
+        }
+        Reflect.deleteProperty(meta, 'root'); // to allow caching (as root can contain cycles)
+        const copy = Utils.copy(meta, false);
+        for (const prop of copy.props) {
+            if (Type.isMappedType(prop.type)) {
+                Reflect.deleteProperty(prop, 'type');
+                Reflect.deleteProperty(prop, 'customType');
+            }
+            if (prop.default) {
+                const raw = RawQueryFragment.getKnownFragment(prop.default);
+                if (raw) {
+                    prop.defaultRaw ??= this.config.getPlatform().formatQuery(raw.sql, raw.params);
+                    Reflect.deleteProperty(prop, 'default');
+                }
+            }
+            Reflect.deleteProperty(prop, 'targetMeta');
+        }
+        [
+            'prototype', 'props', 'referencingProperties', 'propertyOrder', 'relations',
+            'concurrencyCheckKeys', 'checks',
+        ].forEach(key => delete copy[key]);
+        // base entity without properties might not have path, but nothing to cache there
+        if (meta.path) {
+            this.config.getMetadataCacheAdapter().set(this.getCacheKey(meta), copy, meta.path);
+        }
+    }
+    getCacheKey(meta) {
+        /* v8 ignore next */
+        return meta.className + (meta.path ? extname(meta.path) : '');
+    }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/reflection",
   "type": "module",
-  "version": "7.0.0-dev.9",
+  "version": "7.0.0-dev.91",
   "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.",
   "exports": {
     "./package.json": "./package.json",
@@ -38,7 +38,7 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 22.11.0"
+    "node": ">= 22.17.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
@@ -50,13 +50,12 @@
     "access": "public"
   },
   "dependencies": {
-    "globby": "11.1.0",
-    "ts-morph": "25.0.1"
+    "ts-morph": "27.0.2"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.4.13"
+    "@mikro-orm/core": "^6.6.2"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.9"
+    "@mikro-orm/core": "7.0.0-dev.91"
   }
 }