@mikro-orm/core 7.0.2-dev.12 → 7.0.2-dev.14

package/types/BlobType.d.ts

@@ -1,6 +1,7 @@
 import { Uint8ArrayType } from './Uint8ArrayType.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database BLOB/BYTEA column to a Node.js `Buffer`. */
 export declare class BlobType extends Uint8ArrayType {
     convertToJSValue(value: Buffer): Buffer | null;
     compareAsType(): string;

package/types/BlobType.js

@@ -1,4 +1,5 @@
 import { Uint8ArrayType } from './Uint8ArrayType.js';
+/** Maps a database BLOB/BYTEA column to a Node.js `Buffer`. */
 export class BlobType extends Uint8ArrayType {
     convertToJSValue(value) {
         if (value instanceof Buffer || !value) {

package/types/BooleanType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database BOOLEAN/TINYINT(1) column to a JS `boolean`. */
 export declare class BooleanType extends Type<boolean | null | undefined, boolean | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/BooleanType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database BOOLEAN/TINYINT(1) column to a JS `boolean`. */
 export class BooleanType extends Type {
     getColumnType(prop, platform) {
         return platform.getBooleanTypeDeclarationSQL();

package/types/CharacterType.d.ts

@@ -1,6 +1,7 @@
 import { StringType } from './StringType.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database CHAR (fixed-length) column to a JS `string`. */
 export declare class CharacterType extends StringType {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     getDefaultLength(platform: Platform): number;

package/types/CharacterType.js

@@ -1,4 +1,5 @@
 import { StringType } from './StringType.js';
+/** Maps a database CHAR (fixed-length) column to a JS `string`. */
 export class CharacterType extends StringType {
     getColumnType(prop, platform) {
         return platform.getCharTypeDeclarationSQL(prop);

package/types/DateTimeType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database DATETIME/TIMESTAMP column to a JS `Date` object. */
 export declare class DateTimeType extends Type<Date, string> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/DateTimeType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database DATETIME/TIMESTAMP column to a JS `Date` object. */
 export class DateTimeType extends Type {
     getColumnType(prop, platform) {
         return platform.getDateTimeTypeDeclarationSQL({ length: prop.length });

package/types/DateType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database DATE column (date without time) to a JS `string` in YYYY-MM-DD format. */
 export declare class DateType extends Type<string | null | undefined, string | null | undefined> {
     compareAsType(): string;
     ensureComparable(): boolean;

package/types/DateType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database DATE column (date without time) to a JS `string` in YYYY-MM-DD format. */
 export class DateType extends Type {
     compareAsType() {
         return 'string';

package/types/EnumArrayType.d.ts

@@ -2,6 +2,7 @@ import { ArrayType } from './ArrayType.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { TransformContext } from './Type.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database array column to a JS array of enum values, with validation against allowed enum items. */
 export declare class EnumArrayType<T extends string | number = string> extends ArrayType<T> {
     private readonly owner;
     private readonly items?;

package/types/EnumArrayType.js

@@ -6,6 +6,7 @@ function mapHydrator(items, hydrate) {
     }
     return hydrate;
 }
+/** Maps a database array column to a JS array of enum values, with validation against allowed enum items. */
 export class EnumArrayType extends ArrayType {
     owner;
     items;

package/types/EnumType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database ENUM or equivalent column to a JS string. Supports native database enums when available. */
 export declare class EnumType extends Type<string | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/EnumType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database ENUM or equivalent column to a JS string. Supports native database enums when available. */
 export class EnumType extends Type {
     getColumnType(prop, platform) {
         if (prop.nativeEnumName) {

package/types/FloatType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database FLOAT column to a JS `number`. */
 export declare class FloatType extends Type<number | null | undefined, number | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/FloatType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database FLOAT column to a JS `number`. */
 export class FloatType extends Type {
     getColumnType(prop, platform) {
         return platform.getFloatDeclarationSQL();

package/types/IntegerType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database INTEGER/INT column to a JS `number`. */
 export declare class IntegerType extends Type<number | null | undefined, number | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/IntegerType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database INTEGER/INT column to a JS `number`. */
 export class IntegerType extends Type {
     getColumnType(prop, platform) {
         return platform.getIntegerTypeDeclarationSQL(prop);

package/types/IntervalType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database INTERVAL column (PostgreSQL) to a JS `string`. */
 export declare class IntervalType extends Type<string | null | undefined, string | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     convertToJSValue(value: string | null | undefined, platform: Platform): string | null | undefined;

package/types/IntervalType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database INTERVAL column (PostgreSQL) to a JS `string`. */
 export class IntervalType extends Type {
     getColumnType(prop, platform) {
         return platform.getIntervalTypeDeclarationSQL(prop);

package/types/JsonType.d.ts

@@ -1,6 +1,7 @@
 import { Type, type TransformContext } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityMetadata, EntityProperty } from '../typings.js';
+/** Maps a database JSON/JSONB column to a JS object, handling serialization and deserialization. */
 export declare class JsonType extends Type<unknown, string | null> {
     convertToDatabaseValue(value: unknown, platform: Platform, context?: TransformContext): string | null;
     convertToJSValueSQL(key: string, platform: Platform): string;

package/types/JsonType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database JSON/JSONB column to a JS object, handling serialization and deserialization. */
 export class JsonType extends Type {
     convertToDatabaseValue(value, platform, context) {
         if (value == null) {

package/types/MediumIntType.d.ts

@@ -1,6 +1,7 @@
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
 import { IntegerType } from './IntegerType.js';
+/** Maps a database MEDIUMINT column to a JS `number`. */
 export declare class MediumIntType extends IntegerType {
     getColumnType(prop: EntityProperty, platform: Platform): string;
 }

package/types/MediumIntType.js

@@ -1,4 +1,5 @@
 import { IntegerType } from './IntegerType.js';
+/** Maps a database MEDIUMINT column to a JS `number`. */
 export class MediumIntType extends IntegerType {
     getColumnType(prop, platform) {
         return platform.getMediumIntTypeDeclarationSQL(prop);

package/types/SmallIntType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database SMALLINT column to a JS `number`. */
 export declare class SmallIntType extends Type<number | null | undefined, number | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/SmallIntType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database SMALLINT column to a JS `number`. */
 export class SmallIntType extends Type {
     getColumnType(prop, platform) {
         return platform.getSmallIntTypeDeclarationSQL(prop);

package/types/StringType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database VARCHAR column to a JS `string`. */
 export declare class StringType extends Type<string | null | undefined, string | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/StringType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database VARCHAR column to a JS `string`. */
 export class StringType extends Type {
     getColumnType(prop, platform) {
         return platform.getVarcharTypeDeclarationSQL(prop);

package/types/TextType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database TEXT column (unbounded length) to a JS `string`. */
 export declare class TextType extends Type<string | null | undefined, string | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/TextType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database TEXT column (unbounded length) to a JS `string`. */
 export class TextType extends Type {
     getColumnType(prop, platform) {
         return platform.getTextTypeDeclarationSQL(prop);

package/types/TimeType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database TIME column to a JS `string` in HH:MM:SS format. */
 export declare class TimeType extends Type {
     convertToDatabaseValue(value: any, platform: Platform): string;
     compareAsType(): string;

package/types/TimeType.js

@@ -1,5 +1,6 @@
 import { Type } from './Type.js';
 import { ValidationError } from '../errors.js';
+/** Maps a database TIME column to a JS `string` in HH:MM:SS format. */
 export class TimeType extends Type {
     convertToDatabaseValue(value, platform) {
         if (value && !value.toString().match(/^\d{2,}:(?:[0-5]\d):(?:[0-5]\d)$/)) {

package/types/TinyIntType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database TINYINT column to a JS `number`. */
 export declare class TinyIntType extends Type<number | null | undefined, number | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/TinyIntType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database TINYINT column to a JS `number`. */
 export class TinyIntType extends Type {
     getColumnType(prop, platform) {
         return platform.getTinyIntTypeDeclarationSQL(prop);

package/types/Type.d.ts

@@ -2,17 +2,20 @@ import type { Platform } from '../platforms/Platform.js';
 import type { Constructor, EntityMetadata, EntityProperty } from '../typings.js';
 /** @internal */
 export declare const ORM_TYPE: unique symbol;
+/** Context passed to type conversion methods, indicating the conversion mode and source. */
 export interface TransformContext {
     fromQuery?: boolean;
     force?: boolean;
     key?: string;
     mode?: 'hydration' | 'query' | 'query-data' | 'discovery' | 'serialization';
 }
+/** Branded type helper for mapping between JS runtime, database raw, and JSON serialized representations. */
 export type IType<Runtime, Raw, Serialized = Raw> = Runtime & {
     __raw?: Raw;
     __runtime?: Runtime;
     __serialized?: Serialized;
 };
+/** Abstract base class for custom property types that handle conversion between JS and database representations. */
 export declare abstract class Type<JSType = string, DBType = JSType> {
     private static readonly types;
     platform?: Platform;

package/types/Type.js

@@ -1,6 +1,7 @@
 import { inspect } from '../logging/inspect.js';
 /** @internal */
 export const ORM_TYPE = Symbol.for('@mikro-orm/type');
+/** Abstract base class for custom property types that handle conversion between JS and database representations. */
 export class Type {
     static types = new Map();
     platform;

package/types/Uint8ArrayType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database BLOB/BYTEA column to a JS `Uint8Array`. */
 export declare class Uint8ArrayType extends Type<Uint8Array | null> {
     convertToDatabaseValue(value: Uint8Array): Buffer;
     convertToJSValue(value: Buffer): Uint8Array | null;

package/types/Uint8ArrayType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database BLOB/BYTEA column to a JS `Uint8Array`. */
 export class Uint8ArrayType extends Type {
     convertToDatabaseValue(value) {
         if (!value) {

package/types/UnknownType.d.ts

@@ -1,6 +1,7 @@
 import type { EntityProperty } from '../typings.js';
 import type { Platform } from '../platforms/Platform.js';
 import { Type } from './Type.js';
+/** Passthrough type that performs no conversion, used when the column type is unknown or unrecognized. */
 export declare class UnknownType extends Type<unknown | null | undefined, unknown | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     get runtimeType(): string;

package/types/UnknownType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Passthrough type that performs no conversion, used when the column type is unknown or unrecognized. */
 export class UnknownType extends Type {
     getColumnType(prop, platform) {
         return prop.columnTypes?.[0] ?? platform.getVarcharTypeDeclarationSQL(prop);

package/types/UuidType.d.ts

@@ -1,6 +1,7 @@
 import { Type } from './Type.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntityProperty } from '../typings.js';
+/** Maps a database UUID column to a JS `string`, with platform-specific normalization. */
 export declare class UuidType extends Type<string | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;

package/types/UuidType.js

@@ -1,4 +1,5 @@
 import { Type } from './Type.js';
+/** Maps a database UUID column to a JS `string`, with platform-specific normalization. */
 export class UuidType extends Type {
     getColumnType(prop, platform) {
         return platform.getUuidTypeDeclarationSQL(prop);

package/types/index.d.ts

@@ -25,6 +25,7 @@ import { UnknownType } from './UnknownType.js';
 import { UuidType } from './UuidType.js';
 export type { TransformContext, IType };
 export { Type, DateType, TimeType, DateTimeType, BigIntType, BlobType, Uint8ArrayType, ArrayType, EnumArrayType, EnumType, JsonType, IntegerType, SmallIntType, TinyIntType, MediumIntType, FloatType, DoubleType, BooleanType, DecimalType, StringType, UuidType, TextType, UnknownType, IntervalType, CharacterType, };
+/** Registry of all built-in type constructors, keyed by their short name (e.g., `types.integer`, `types.uuid`). */
 export declare const types: {
     readonly date: typeof DateType;
     readonly time: typeof TimeType;
@@ -51,6 +52,7 @@ export declare const types: {
     readonly interval: typeof IntervalType;
     readonly unknown: typeof UnknownType;
 };
+/** Shorthand alias for the `types` registry. */
 export declare const t: {
     readonly date: typeof DateType;
     readonly time: typeof TimeType;

package/types/index.js

@@ -24,6 +24,7 @@ import { Uint8ArrayType } from './Uint8ArrayType.js';
 import { UnknownType } from './UnknownType.js';
 import { UuidType } from './UuidType.js';
 export { Type, DateType, TimeType, DateTimeType, BigIntType, BlobType, Uint8ArrayType, ArrayType, EnumArrayType, EnumType, JsonType, IntegerType, SmallIntType, TinyIntType, MediumIntType, FloatType, DoubleType, BooleanType, DecimalType, StringType, UuidType, TextType, UnknownType, IntervalType, CharacterType, };
+/** Registry of all built-in type constructors, keyed by their short name (e.g., `types.integer`, `types.uuid`). */
 export const types = {
     date: DateType,
     time: TimeType,
@@ -50,6 +51,7 @@ export const types = {
     interval: IntervalType,
     unknown: UnknownType,
 };
+/** Shorthand alias for the `types` registry. */
 export const t = types;
 /**
  * Brand each built-in type constructor with its registry key via a cross-module symbol.