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

package/MsSqlConnection.js

@@ -45,7 +45,7 @@ export class MsSqlConnection extends AbstractSqlConnection {
             },
             server: options.host,
         };
-        /* v8 ignore next 6 */
+        /* v8 ignore next */
         if (ret.server.includes('\\')) {
             const [host, ...name] = ret.server.split('\\');
             ret.server = host;

package/MsSqlDriver.d.ts

@@ -6,4 +6,5 @@ export declare class MsSqlDriver extends AbstractSqlDriver<MsSqlConnection> {
     constructor(config: Configuration);
     nativeInsertMany<T extends AnyEntity<T>>(entityName: string, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>;
     createQueryBuilder<T extends AnyEntity<T>>(entityName: string, ctx?: Transaction, preferredConnectionType?: ConnectionType, convertCustomTypes?: boolean, loggerContext?: LoggingOptions, alias?: string, em?: SqlEntityManager): MsSqlQueryBuilder<T, any, any, any>;
+    private appendOutputTable;
 }

package/MsSqlDriver.js

@@ -1,4 +1,4 @@
-import { QueryFlag, Utils, } from '@mikro-orm/core';
+import { QueryFlag, Utils, isRaw, } from '@mikro-orm/core';
 import { AbstractSqlDriver } from '@mikro-orm/knex';
 import { MsSqlConnection } from './MsSqlConnection.js';
 import { MsSqlPlatform } from './MsSqlPlatform.js';
@@ -37,7 +37,7 @@ export class MsSqlDriver extends AbstractSqlDriver {
                 return `set identity_insert ${tableName} on; ${sql}; set identity_insert ${tableName} off`;
             });
         }
-        return super.nativeInsertMany(entityName, data, options);
+        return super.nativeInsertMany(entityName, data, options, sql => meta.hasTriggers ? this.appendOutputTable(entityName, data, sql) : sql);
     }
     createQueryBuilder(entityName, ctx, preferredConnectionType, convertCustomTypes, loggerContext, alias, em) {
         // do not compute the connectionType if EM is provided as it will be computed from it in the QB later on
@@ -48,4 +48,27 @@ export class MsSqlDriver extends AbstractSqlDriver {
         }
         return qb;
     }
+    appendOutputTable(entityName, data, sql) {
+        const meta = this.metadata.get(entityName);
+        const returningProps = meta.props
+            .filter(prop => prop.persist !== false && prop.defaultRaw || prop.autoincrement || prop.generated)
+            .filter(prop => !(prop.name in data[0]) || isRaw(data[0][prop.name]));
+        const returningFields = Utils.flatten(returningProps.map(prop => prop.fieldNames));
+        /* v8 ignore next */
+        if (returningFields.length === 0) {
+            return sql;
+        }
+        const tableName = this.getTableName(meta, {}, true);
+        const selections = returningFields
+            .map((field) => `[t].${this.platform.quoteIdentifier(field)}`)
+            .join(',');
+        const position = sql.indexOf(' values ');
+        const sqlBeforeValues = sql.substring(0, position);
+        const sqlAfterValues = sql.substring(position + 1);
+        let outputSql = `select top(0) ${selections} into #out from ${tableName} as t left join ${tableName} on 0 = 1; `;
+        outputSql += `${sqlBeforeValues} into #out ${sqlAfterValues}; `;
+        outputSql += `select ${selections} from #out as t; `;
+        outputSql += `drop table #out`;
+        return outputSql;
+    }
 }

package/MsSqlExceptionConverter.d.ts

@@ -1,8 +1,8 @@
 import { ExceptionConverter, type Dictionary, type DriverException } from '@mikro-orm/core';
 export declare class MsSqlExceptionConverter extends ExceptionConverter {
     /**
-     * @link https://docs.microsoft.com/en-us/sql/relational-databases/errors-events/mssqlserver-511-database-engine-error?view=sql-server-ver15
-     * @link https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractPostgreSQLDriver.php
+     * @see https://docs.microsoft.com/en-us/sql/relational-databases/errors-events/mssqlserver-511-database-engine-error?view=sql-server-ver15
+     * @see https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractPostgreSQLDriver.php
      */
     convertException(exception: Error & Dictionary): DriverException;
 }

package/MsSqlExceptionConverter.js

@@ -1,12 +1,12 @@
 import { ExceptionConverter, InvalidFieldNameException, NonUniqueFieldNameException, NotNullConstraintViolationException, SyntaxErrorException, TableExistsException, TableNotFoundException, UniqueConstraintViolationException, } from '@mikro-orm/core';
 export class MsSqlExceptionConverter extends ExceptionConverter {
     /**
-     * @link https://docs.microsoft.com/en-us/sql/relational-databases/errors-events/mssqlserver-511-database-engine-error?view=sql-server-ver15
-     * @link https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractPostgreSQLDriver.php
+     * @see https://docs.microsoft.com/en-us/sql/relational-databases/errors-events/mssqlserver-511-database-engine-error?view=sql-server-ver15
+     * @see https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractPostgreSQLDriver.php
      */
     convertException(exception) {
         let errno = exception.number;
-        /* v8 ignore next 5 */
+        /* v8 ignore next */
         if ('errors' in exception && Array.isArray(exception.errors) && typeof exception.errors[0] === 'object' && 'message' in exception.errors[0]) {
             exception.message += '\n' + exception.errors.map(e => e.message).join('\n');
             errno ??= exception.errors[0].number;

package/MsSqlMikroORM.d.ts

@@ -1,19 +1,18 @@
-import { MikroORM, type Options, type IDatabaseDriver, type EntityManager, type EntityManagerType } from '@mikro-orm/core';
-import { MsSqlDriver } from './MsSqlDriver.js';
+import { type AnyEntity, type EntityClass, type EntitySchema, MikroORM, type Options, type IDatabaseDriver, type EntityManager, type EntityManagerType } from '@mikro-orm/core';
 import type { SqlEntityManager } from '@mikro-orm/knex';
+import { MsSqlDriver } from './MsSqlDriver.js';
+export type MsSqlOptions<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Options<MsSqlDriver, EM, Entities>;
+export declare function defineMsSqlConfig<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Options<MsSqlDriver, EM, Entities>): Options<MsSqlDriver, EM, Entities>;
 /**
  * @inheritDoc
  */
-export declare class MsSqlMikroORM<EM extends EntityManager = SqlEntityManager> extends MikroORM<MsSqlDriver, EM> {
-    private static DRIVER;
+export declare class MsSqlMikroORM<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends MikroORM<MsSqlDriver, EM, Entities> {
     /**
      * @inheritDoc
      */
-    static init<D extends IDatabaseDriver = MsSqlDriver, EM extends EntityManager = D[typeof EntityManagerType] & EntityManager>(options?: Options<D, EM>): Promise<MikroORM<D, EM>>;
+    static init<D extends IDatabaseDriver = MsSqlDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Options<D, EM, Entities>): Promise<MikroORM<D, EM, Entities>>;
     /**
      * @inheritDoc
      */
-    static initSync<D extends IDatabaseDriver = MsSqlDriver, EM extends EntityManager = D[typeof EntityManagerType] & EntityManager>(options: Options<D, EM>): MikroORM<D, EM>;
+    constructor(options: Options<MsSqlDriver, EM, Entities>);
 }
-export type MsSqlOptions = Options<MsSqlDriver>;
-export declare function defineMsSqlConfig(options: MsSqlOptions): Options<MsSqlDriver, SqlEntityManager<MsSqlDriver> & EntityManager<IDatabaseDriver<import("@mikro-orm/core").Connection>>>;

package/MsSqlMikroORM.js

@@ -1,24 +1,22 @@
 import { defineConfig, MikroORM, } from '@mikro-orm/core';
 import { MsSqlDriver } from './MsSqlDriver.js';
+export function defineMsSqlConfig(options) {
+    return defineConfig({ driver: MsSqlDriver, ...options });
+}
 /**
  * @inheritDoc
  */
 export class MsSqlMikroORM extends MikroORM {
-    static DRIVER = MsSqlDriver;
     /**
      * @inheritDoc
      */
     static async init(options) {
-        return super.init(options);
+        return super.init(defineMsSqlConfig(options));
     }
     /**
      * @inheritDoc
      */
-    static initSync(options) {
-        return super.initSync(options);
+    constructor(options) {
+        super(defineMsSqlConfig(options));
     }
 }
-/* v8 ignore next 3 */
-export function defineMsSqlConfig(options) {
-    return defineConfig({ driver: MsSqlDriver, ...options });
-}

package/MsSqlPlatform.d.ts

@@ -1,12 +1,13 @@
-import { AbstractSqlPlatform, type EntityMetadata, type IDatabaseDriver, type EntityManager, type MikroORM, Type, type Primary, type IPrimaryKey, MsSqlNativeQueryBuilder } from '@mikro-orm/knex';
+import { AbstractSqlPlatform, type EntityManager, type EntityMetadata, type IDatabaseDriver, type IPrimaryKey, type MikroORM, MsSqlNativeQueryBuilder, type Primary, QueryOrder, Type } from '@mikro-orm/knex';
 import { MsSqlSchemaHelper } from './MsSqlSchemaHelper.js';
 import { MsSqlExceptionConverter } from './MsSqlExceptionConverter.js';
 import { MsSqlSchemaGenerator } from './MsSqlSchemaGenerator.js';
+import type { MsSqlDriver } from './MsSqlDriver.js';
 export declare class MsSqlPlatform extends AbstractSqlPlatform {
     protected readonly schemaHelper: MsSqlSchemaHelper;
     protected readonly exceptionConverter: MsSqlExceptionConverter;
     /** @inheritDoc */
-    lookupExtensions(orm: MikroORM): void;
+    lookupExtensions(orm: MikroORM<MsSqlDriver>): void;
     /** @inheritDoc */
     init(orm: MikroORM): void;
     getRollbackToSavepointSQL(savepointName: string): string;
@@ -55,9 +56,12 @@ export declare class MsSqlPlatform extends AbstractSqlPlatform {
     usesEnumCheckConstraints(): boolean;
     supportsMultipleCascadePaths(): boolean;
     supportsMultipleStatements(): boolean;
-    quoteIdentifier(id: string): string;
+    quoteIdentifier(id: string | {
+        toString: () => string;
+    }): string;
     escape(value: any): string;
     getSchemaGenerator(driver: IDatabaseDriver, em?: EntityManager): MsSqlSchemaGenerator;
     allowsComparingTuples(): boolean;
+    getOrderByExpression(column: string, direction: QueryOrder): string[];
     getDefaultClientUrl(): string;
 }

package/MsSqlPlatform.js

@@ -1,4 +1,4 @@
-import { AbstractSqlPlatform, raw, Type, Utils, ALIAS_REPLACEMENT, DoubleType, FloatType, RawQueryFragment, MsSqlNativeQueryBuilder, } from '@mikro-orm/knex';
+import { AbstractSqlPlatform, ALIAS_REPLACEMENT, DoubleType, FloatType, MsSqlNativeQueryBuilder, QueryOrder, raw, RawQueryFragment, Type, } from '@mikro-orm/knex';
 // @ts-expect-error no types available
 import SqlString from 'tsqlstring';
 import { MsSqlSchemaHelper } from './MsSqlSchemaHelper.js';
@@ -33,7 +33,7 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         return true;
     }
     convertDateToJSValue(value) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (typeof value === 'string') {
             return value;
         }
@@ -83,7 +83,7 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         return super.getVarcharTypeDeclarationSQL(column);
     }
     getEnumTypeDeclarationSQL(column) {
-        if (column.items?.every(item => Utils.isString(item))) {
+        if (column.items?.every(item => typeof item === 'string')) {
             return Type.getType(UnicodeStringType).getColumnType({ length: 100, ...column }, this);
         }
         /* v8 ignore next */
@@ -149,14 +149,14 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         };
         const cast = (key) => raw(type in types ? `cast(${key} as ${types[type]})` : key);
         const quoteKey = (key) => key.match(/^[a-z]\w*$/i) ? key : `"${key}"`;
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (path.length === 0) {
             return cast(`json_value(${root}, '$.${b.map(quoteKey).join('.')}')`);
         }
         return cast(`json_value(${root}, '$.${b.map(quoteKey).join('.')}')`);
     }
     normalizePrimaryKey(data) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (data instanceof UnicodeString) {
             return data.value;
         }
@@ -175,7 +175,7 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         if (RawQueryFragment.isKnownFragment(id)) {
             return super.quoteIdentifier(id);
         }
-        return `[${id.replace('.', `].[`)}]`;
+        return `[${id.toString().replace('.', `].[`)}]`;
     }
     escape(value) {
         if (value instanceof UnicodeString) {
@@ -189,13 +189,27 @@ export class MsSqlPlatform extends AbstractSqlPlatform {
         }
         return SqlString.escape(value);
     }
-    /* v8 ignore next 3: kept for type inference only */
+    /* v8 ignore next: kept for type inference only */
     getSchemaGenerator(driver, em) {
         return new MsSqlSchemaGenerator(em ?? driver);
     }
     allowsComparingTuples() {
         return false;
     }
+    getOrderByExpression(column, direction) {
+        switch (direction.toUpperCase()) {
+            case QueryOrder.ASC_NULLS_FIRST:
+                return [`case when ${column} is null then 0 else 1 end, ${column} asc`];
+            case QueryOrder.ASC_NULLS_LAST:
+                return [`case when ${column} is null then 1 else 0 end, ${column} asc`];
+            case QueryOrder.DESC_NULLS_FIRST:
+                return [`case when ${column} is null then 0 else 1 end, ${column} desc`];
+            case QueryOrder.DESC_NULLS_LAST:
+                return [`case when ${column} is null then 1 else 0 end, ${column} desc`];
+            default:
+                return [`${column} ${direction.toLowerCase()}`];
+        }
+    }
     getDefaultClientUrl() {
         return 'mssql://sa@localhost:1433';
     }

package/MsSqlQueryBuilder.js

@@ -3,6 +3,12 @@ import { QueryBuilder } from '@mikro-orm/knex';
 export class MsSqlQueryBuilder extends QueryBuilder {
     insert(data) {
         this.checkIdentityInsert(data);
+        if (!this.flags.has(QueryFlag.IDENTITY_INSERT) && this.metadata.has(this.mainAlias.entityName)) {
+            const meta = this.metadata.find(this.mainAlias.entityName);
+            if (meta.hasTriggers) {
+                this.setFlag(QueryFlag.OUTPUT_TABLE);
+            }
+        }
         return super.insert(data);
     }
     checkIdentityInsert(data) {

package/MsSqlSchemaGenerator.d.ts

@@ -1,6 +1,7 @@
 import { type ClearDatabaseOptions, type DropSchemaOptions, type MikroORM, SchemaGenerator } from '@mikro-orm/knex';
+import type { MsSqlDriver } from './MsSqlDriver.js';
 export declare class MsSqlSchemaGenerator extends SchemaGenerator {
-    static register(orm: MikroORM): void;
-    clearDatabase(options?: ClearDatabaseOptions): Promise<void>;
+    static register(orm: MikroORM<MsSqlDriver>): void;
+    clear(options?: ClearDatabaseOptions): Promise<void>;
     getDropSchemaSQL(options?: Omit<DropSchemaOptions, 'dropDb'>): Promise<string>;
 }

package/MsSqlSchemaGenerator.js

@@ -3,11 +3,11 @@ export class MsSqlSchemaGenerator extends SchemaGenerator {
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/schema-generator', () => new MsSqlSchemaGenerator(orm.em));
     }
-    async clearDatabase(options) {
+    async clear(options) {
         // truncate by default, so no value is considered as true
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (options?.truncate === false) {
-            return super.clearDatabase(options);
+            return super.clear(options);
         }
         // https://stackoverflow.com/questions/253849/cannot-truncate-table-because-it-is-being-referenced-by-a-foreign-key-constraint
         for (const meta of this.getOrderedMetadata(options?.schema).reverse()) {

package/MsSqlSchemaHelper.js

@@ -382,7 +382,7 @@ export class MsSqlSchemaHelper extends SchemaHelper {
         return parts;
     }
     getCreateIndexSQL(tableName, index, partialExpression = false) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (index.expression && !partialExpression) {
             return index.expression;
         }

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/UnicodeStringType.js

@@ -23,7 +23,7 @@ export class UnicodeStringType extends Type {
         return `nvarchar(${length})`;
     }
     convertToJSValue(value) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (value instanceof UnicodeString) {
             return value.value;
         }

package/index.d.ts

@@ -5,4 +5,4 @@ export * from './MsSqlPlatform.js';
 export * from './MsSqlSchemaHelper.js';
 export * from './MsSqlExceptionConverter.js';
 export * from './UnicodeStringType.js';
-export { MsSqlMikroORM as MikroORM, MsSqlOptions as Options, defineMsSqlConfig as defineConfig, } from './MsSqlMikroORM.js';
+export { MsSqlMikroORM as MikroORM, type MsSqlOptions as Options, defineMsSqlConfig as defineConfig, } from './MsSqlMikroORM.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/mssql",
   "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,17 +50,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@mikro-orm/knex": "7.0.0-dev.9",
+    "@mikro-orm/knex": "7.0.0-dev.91",
     "tarn": "3.0.2",
-    "tedious": "19.0.0",
+    "tedious": "19.1.3",
     "tsqlstring": "1.0.1"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.4.13",
-    "kysely": "0.28.0"
+    "@mikro-orm/core": "^6.6.2",
+    "kysely": "0.28.8"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.9",
+    "@mikro-orm/core": "7.0.0-dev.91",
     "kysely": "*"
   }
 }