@mikro-orm/mssql 7.0.2-dev.13 → 7.0.2-dev.14

package/MsSqlConnection.d.ts

@@ -1,6 +1,7 @@
 import { AbstractSqlConnection, type TransactionEventBroadcaster } from '@mikro-orm/sql';
 import { type ControlledTransaction, MssqlDialect } from 'kysely';
 import type { ConnectionConfiguration } from 'tedious';
+/** Microsoft SQL Server database connection using the `tedious` driver. */
 export declare class MsSqlConnection extends AbstractSqlConnection {
     createKyselyDialect(overrides: ConnectionConfiguration): MssqlDialect;
     private mapOptions;

package/MsSqlConnection.js

@@ -2,6 +2,7 @@ import { AbstractSqlConnection, Utils } from '@mikro-orm/sql';
 import { MssqlDialect } from 'kysely';
 import * as Tedious from 'tedious';
 import * as Tarn from 'tarn';
+/** Microsoft SQL Server database connection using the `tedious` driver. */
 export class MsSqlConnection extends AbstractSqlConnection {
     createKyselyDialect(overrides) {
         const options = this.mapOptions(overrides);

package/MsSqlDriver.d.ts

@@ -3,6 +3,7 @@ import { AbstractSqlDriver, type SqlEntityManager } from '@mikro-orm/sql';
 import { MsSqlConnection } from './MsSqlConnection.js';
 import { MsSqlQueryBuilder } from './MsSqlQueryBuilder.js';
 import { MsSqlMikroORM } from './MsSqlMikroORM.js';
+/** Database driver for Microsoft SQL Server. */
 export declare class MsSqlDriver extends AbstractSqlDriver<MsSqlConnection> {
     constructor(config: Configuration);
     nativeInsertMany<T extends AnyEntity<T>>(entityName: EntityName<T>, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>;

package/MsSqlDriver.js

@@ -4,6 +4,7 @@ import { MsSqlConnection } from './MsSqlConnection.js';
 import { MsSqlPlatform } from './MsSqlPlatform.js';
 import { MsSqlQueryBuilder } from './MsSqlQueryBuilder.js';
 import { MsSqlMikroORM } from './MsSqlMikroORM.js';
+/** Database driver for Microsoft SQL Server. */
 export class MsSqlDriver extends AbstractSqlDriver {
     constructor(config) {
         super(config, new MsSqlPlatform(), MsSqlConnection, ['kysely', 'tedious']);

package/MsSqlExceptionConverter.d.ts

@@ -1,4 +1,5 @@
 import { ExceptionConverter, type Dictionary, type DriverException } from '@mikro-orm/core';
+/** Converts MSSQL native errors into typed MikroORM driver exceptions. */
 export declare class MsSqlExceptionConverter extends ExceptionConverter {
     /**
      * @see https://docs.microsoft.com/en-us/sql/relational-databases/errors-events/mssqlserver-511-database-engine-error?view=sql-server-ver15

package/MsSqlExceptionConverter.js

@@ -1,4 +1,5 @@
 import { ExceptionConverter, InvalidFieldNameException, NonUniqueFieldNameException, NotNullConstraintViolationException, SyntaxErrorException, TableExistsException, TableNotFoundException, UniqueConstraintViolationException, } from '@mikro-orm/core';
+/** Converts MSSQL native errors into typed MikroORM driver exceptions. */
 export class MsSqlExceptionConverter extends ExceptionConverter {
     /**
      * @see https://docs.microsoft.com/en-us/sql/relational-databases/errors-events/mssqlserver-511-database-engine-error?view=sql-server-ver15

package/MsSqlMikroORM.d.ts

@@ -1,7 +1,9 @@
 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/sql';
 import { MsSqlDriver } from './MsSqlDriver.js';
+/** Configuration options for the MSSQL driver. */
 export type MsSqlOptions<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<MsSqlDriver, EM, Entities>>;
+/** Creates a type-safe configuration object for the MSSQL driver. */
 export declare function defineMsSqlConfig<EM extends SqlEntityManager<MsSqlDriver> = SqlEntityManager<MsSqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<MsSqlDriver, EM, Entities>>): Partial<Options<MsSqlDriver, EM, Entities>>;
 /**
  * @inheritDoc

package/MsSqlMikroORM.js

@@ -1,5 +1,6 @@
 import { defineConfig, MikroORM, } from '@mikro-orm/core';
 import { MsSqlDriver } from './MsSqlDriver.js';
+/** Creates a type-safe configuration object for the MSSQL driver. */
 export function defineMsSqlConfig(options) {
     return defineConfig({ driver: MsSqlDriver, ...options });
 }

package/MsSqlPlatform.d.ts

@@ -3,6 +3,7 @@ import { MsSqlSchemaHelper } from './MsSqlSchemaHelper.js';
 import { MsSqlExceptionConverter } from './MsSqlExceptionConverter.js';
 import { MsSqlSchemaGenerator } from './MsSqlSchemaGenerator.js';
 import type { MsSqlDriver } from './MsSqlDriver.js';
+/** Platform implementation for Microsoft SQL Server. */
 export declare class MsSqlPlatform extends AbstractSqlPlatform {
     #private;
     protected readonly schemaHelper: MsSqlSchemaHelper;

package/MsSqlPlatform.js

@@ -6,6 +6,7 @@ import { MsSqlExceptionConverter } from './MsSqlExceptionConverter.js';
 import { MsSqlSchemaGenerator } from './MsSqlSchemaGenerator.js';
 import { UnicodeCharacterType } from './UnicodeCharacterType.js';
 import { UnicodeString, UnicodeStringType } from './UnicodeStringType.js';
+/** Platform implementation for Microsoft SQL Server. */
 export class MsSqlPlatform extends AbstractSqlPlatform {
     schemaHelper = new MsSqlSchemaHelper(this);
     exceptionConverter = new MsSqlExceptionConverter();

package/MsSqlQueryBuilder.d.ts

@@ -1,5 +1,6 @@
 import { type AnyEntity, type RequiredEntityData } from '@mikro-orm/core';
 import { type InsertQueryBuilder, QueryBuilder } from '@mikro-orm/sql';
+/** Query builder with MSSQL-specific behavior such as identity insert handling. */
 export declare class MsSqlQueryBuilder<Entity extends object = AnyEntity, RootAlias extends string = never, Hint extends string = never, Context extends object = never> extends QueryBuilder<Entity, RootAlias, Hint, Context> {
     insert(data: RequiredEntityData<Entity> | RequiredEntityData<Entity>[]): InsertQueryBuilder<Entity, RootAlias, Context>;
     private checkIdentityInsert;

package/MsSqlQueryBuilder.js

@@ -1,5 +1,6 @@
 import { QueryFlag, Utils } from '@mikro-orm/core';
 import { QueryBuilder } from '@mikro-orm/sql';
+/** Query builder with MSSQL-specific behavior such as identity insert handling. */
 export class MsSqlQueryBuilder extends QueryBuilder {
     insert(data) {
         this.checkIdentityInsert(data);

package/MsSqlSchemaGenerator.d.ts

@@ -1,5 +1,6 @@
 import { type ClearDatabaseOptions, type DropSchemaOptions, type MikroORM, SchemaGenerator } from '@mikro-orm/sql';
 import type { MsSqlDriver } from './MsSqlDriver.js';
+/** Schema generator with MSSQL-specific behavior for clearing and dropping schemas. */
 export declare class MsSqlSchemaGenerator extends SchemaGenerator {
     static register(orm: MikroORM<MsSqlDriver>): void;
     clear(options?: ClearDatabaseOptions): Promise<void>;

package/MsSqlSchemaGenerator.js

@@ -1,4 +1,5 @@
 import { SchemaGenerator } from '@mikro-orm/sql';
+/** Schema generator with MSSQL-specific behavior for clearing and dropping schemas. */
 export class MsSqlSchemaGenerator extends SchemaGenerator {
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/schema-generator', () => new MsSqlSchemaGenerator(orm.em));

package/MsSqlSchemaHelper.d.ts

@@ -1,4 +1,5 @@
 import { type AbstractSqlConnection, type CheckDef, type Column, type DatabaseSchema, type DatabaseTable, type Dictionary, type ForeignKey, type IndexDef, SchemaHelper, type Table, type TableDifference, type Type } from '@mikro-orm/sql';
+/** Schema introspection helper for Microsoft SQL Server. */
 export declare class MsSqlSchemaHelper extends SchemaHelper {
     static readonly DEFAULT_VALUES: {
         true: string[];

package/MsSqlSchemaHelper.js

@@ -1,5 +1,6 @@
 import { EnumType, SchemaHelper, StringType, TextType, Utils, } from '@mikro-orm/sql';
 import { UnicodeStringType } from './UnicodeStringType.js';
+/** Schema introspection helper for Microsoft SQL Server. */
 export class MsSqlSchemaHelper extends SchemaHelper {
     static DEFAULT_VALUES = {
         true: ['1'],

package/UnicodeCharacterType.d.ts

@@ -1,5 +1,6 @@
 import type { Platform, EntityProperty } from '@mikro-orm/core';
 import { UnicodeStringType } from './UnicodeStringType.js';
+/** Custom type for MSSQL nchar (fixed-length Unicode character) columns. */
 export declare class UnicodeCharacterType extends UnicodeStringType {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     getDefaultLength(platform: Platform): number;

package/UnicodeCharacterType.js

@@ -1,4 +1,5 @@
 import { UnicodeStringType } from './UnicodeStringType.js';
+/** Custom type for MSSQL nchar (fixed-length Unicode character) columns. */
 export class UnicodeCharacterType extends UnicodeStringType {
     getColumnType(prop, platform) {
         const length = prop.length === -1 ? 'max' : (prop.length ?? this.getDefaultLength(platform));

package/UnicodeStringType.d.ts

@@ -1,4 +1,5 @@
 import { type Platform, Type } from '@mikro-orm/core';
+/** Wrapper for string values that should be stored as Unicode (nvarchar) in MSSQL. */
 export declare class UnicodeString {
     readonly value: string;
     constructor(value: string);
@@ -7,6 +8,7 @@ export declare class UnicodeString {
     toJSON(): string;
     [Symbol.toPrimitive](): string;
 }
+/** Custom type for MSSQL nvarchar columns with automatic Unicode string wrapping. */
 export declare class UnicodeStringType extends Type<string | null, string | null> {
     getColumnType(prop: {
         length?: number;

package/UnicodeStringType.js

@@ -1,4 +1,5 @@
 import { Type } from '@mikro-orm/core';
+/** Wrapper for string values that should be stored as Unicode (nvarchar) in MSSQL. */
 export class UnicodeString {
     value;
     constructor(value) {
@@ -17,6 +18,7 @@ export class UnicodeString {
         return this.value;
     }
 }
+/** Custom type for MSSQL nvarchar columns with automatic Unicode string wrapping. */
 export class UnicodeStringType extends Type {
     getColumnType(prop, platform) {
         const length = prop.length === -1 ? 'max' : (prop.length ?? this.getDefaultLength(platform));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mssql",
-  "version": "7.0.2-dev.13",
+  "version": "7.0.2-dev.14",
   "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,7 +47,7 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.0.2-dev.13",
+    "@mikro-orm/sql": "7.0.2-dev.14",
     "kysely": "0.28.11",
     "tarn": "3.0.2",
     "tedious": "19.2.1",
@@ -57,7 +57,7 @@
     "@mikro-orm/core": "^7.0.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.2-dev.13"
+    "@mikro-orm/core": "7.0.2-dev.14"
   },
   "engines": {
     "node": ">= 22.17.0"