metal-orm 1.1.10 → 1.1.16

package/src/dto/filter-types.ts

@@ -1,117 +1,117 @@
-/**
- * Filter types for building type-safe query filters from JSON input.
- * Designed for REST API query parameters.
- */
-
-import type { TableDef } from '../schema/table.js';
-import type { ColumnDef, ColumnType } from '../schema/column-types.js';
-import type { EntityConstructor } from '../orm/entity-metadata.js';
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Entity support: Extract columns from entity constructor
-// ─────────────────────────────────────────────────────────────────────────────
-
-/**
- * Checks if a type is a TableDef.
- */
-type IsTableDef<T> = T extends { name: string; columns: Record<string, unknown> } ? true : false;
-
-/**
- * Maps TypeScript types to SQL column types for EntityConstructor columns.
- */
-type TsTypeToColumnType<T> =
-  T extends string ? 'VARCHAR' :
-  T extends number ? 'INT' :
-  T extends boolean ? 'BOOLEAN' :
-  T extends Date ? 'TIMESTAMP' :
-  'VARCHAR';
-
-/**
- * Extracts the column map from either a TableDef or EntityConstructor.
- * For EntityConstructor, infers column type from TypeScript property type.
- */
-type ExtractColumns<T> = IsTableDef<T> extends true
-  ? T extends TableDef<infer C> ? C : never
-  : T extends EntityConstructor<infer E>
-  ? {
-      [K in keyof E]: ColumnDef<TsTypeToColumnType<E[K]>, E[K]>;
-    }
-  : never;
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Scalar filter types per data type
-// ─────────────────────────────────────────────────────────────────────────────
-
-/**
- * Filter operators for string columns.
- */
-export interface StringFilter {
-  equals?: string;
-  not?: string;
-  in?: string[];
-  notIn?: string[];
-  contains?: string;
-  startsWith?: string;
-  endsWith?: string;
-  /** Case-insensitive matching (for contains, startsWith, endsWith) */
-  mode?: 'default' | 'insensitive';
-}
-
-/**
- * Filter operators for numeric columns (number, bigint).
- */
-export interface NumberFilter {
-  equals?: number;
-  not?: number;
-  in?: number[];
-  notIn?: number[];
-  lt?: number;
-  lte?: number;
-  gt?: number;
-  gte?: number;
-}
-
-/**
- * Filter operators for boolean columns.
- */
-export interface BooleanFilter {
-  equals?: boolean;
-  not?: boolean;
-}
-
-/**
- * Filter operators for date/datetime columns.
- * Accepts ISO date strings.
- */
-export interface DateFilter {
-  equals?: string;
-  not?: string;
-  in?: string[];
-  notIn?: string[];
-  lt?: string;
-  lte?: string;
-  gt?: string;
-  gte?: string;
-}
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Type mapping: ColumnDef → appropriate filter type
-// ─────────────────────────────────────────────────────────────────────────────
-
-type NormalizedType<T extends ColumnDef> = Lowercase<T['type'] & string>;
-
-/**
- * Maps a column definition to its appropriate filter type.
- */
-export type FieldFilter<TCol extends ColumnDef> =
-  NormalizedType<TCol> extends 'int' | 'integer' | 'bigint' | 'decimal' | 'float' | 'double'
-    ? NumberFilter
-  : NormalizedType<TCol> extends 'boolean'
-    ? BooleanFilter
-  : NormalizedType<TCol> extends 'date' | 'datetime' | 'timestamp' | 'timestamptz'
-    ? DateFilter
-  : StringFilter; // default to string for varchar, text, uuid, etc.
-
+/**
+ * Filter types for building type-safe query filters from JSON input.
+ * Designed for REST API query parameters.
+ */
+
+import type { TableDef } from '../schema/table.js';
+import type { ColumnDef, ColumnType } from '../schema/column-types.js';
+import type { EntityConstructor } from '../orm/entity-metadata.js';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Entity support: Extract columns from entity constructor
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Checks if a type is a TableDef.
+ */
+type IsTableDef<T> = T extends { name: string; columns: Record<string, unknown> } ? true : false;
+
+/**
+ * Maps TypeScript types to SQL column types for EntityConstructor columns.
+ */
+type TsTypeToColumnType<T> =
+  T extends string ? 'VARCHAR' :
+  T extends number ? 'INT' :
+  T extends boolean ? 'BOOLEAN' :
+  T extends Date ? 'TIMESTAMP' :
+  'VARCHAR';
+
+/**
+ * Extracts the column map from either a TableDef or EntityConstructor.
+ * For EntityConstructor, infers column type from TypeScript property type.
+ */
+type ExtractColumns<T> = IsTableDef<T> extends true
+  ? T extends TableDef<infer C> ? C : never
+  : T extends EntityConstructor<infer E>
+  ? {
+      [K in keyof E]: ColumnDef<TsTypeToColumnType<E[K]>, E[K]>;
+    }
+  : never;
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Scalar filter types per data type
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Filter operators for string columns.
+ */
+export interface StringFilter {
+  equals?: string;
+  not?: string;
+  in?: string[];
+  notIn?: string[];
+  contains?: string;
+  startsWith?: string;
+  endsWith?: string;
+  /** Case-insensitive matching (for contains, startsWith, endsWith) */
+  mode?: 'default' | 'insensitive';
+}
+
+/**
+ * Filter operators for numeric columns (number, bigint).
+ */
+export interface NumberFilter {
+  equals?: number;
+  not?: number;
+  in?: number[];
+  notIn?: number[];
+  lt?: number;
+  lte?: number;
+  gt?: number;
+  gte?: number;
+}
+
+/**
+ * Filter operators for boolean columns.
+ */
+export interface BooleanFilter {
+  equals?: boolean;
+  not?: boolean;
+}
+
+/**
+ * Filter operators for date/datetime columns.
+ * Accepts ISO date strings.
+ */
+export interface DateFilter {
+  equals?: string;
+  not?: string;
+  in?: string[];
+  notIn?: string[];
+  lt?: string;
+  lte?: string;
+  gt?: string;
+  gte?: string;
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Type mapping: ColumnDef → appropriate filter type
+// ─────────────────────────────────────────────────────────────────────────────
+
+type NormalizedType<T extends ColumnDef> = Lowercase<T['type'] & string>;
+
+/**
+ * Maps a column definition to its appropriate filter type.
+ */
+export type FieldFilter<TCol extends ColumnDef> =
+  NormalizedType<TCol> extends 'int' | 'integer' | 'bigint' | 'decimal' | 'float' | 'double'
+    ? NumberFilter
+  : NormalizedType<TCol> extends 'boolean'
+    ? BooleanFilter
+  : NormalizedType<TCol> extends 'date' | 'datetime' | 'timestamp' | 'timestamptz'
+    ? DateFilter
+  : StringFilter; // default to string for varchar, text, uuid, etc.
+
 // ─────────────────────────────────────────────────────────────────────────────
 // SimpleWhereInput: field-only filters (no AND/OR/NOT logic)
 // ─────────────────────────────────────────────────────────────────────────────
@@ -136,33 +136,33 @@ export type WhereInput<T extends TableDef | EntityConstructor> =
   | ColumnFilter<T>
   | RelationFilterInput<T>
   | (ColumnFilter<T> & RelationFilterInput<T>);
-
-/**
- * Restricted where input - only specified columns are filterable.
- * Use this to limit which fields can be filtered via API.
- *
- * Works with both TableDef and EntityConstructor.
- *
- * @example
- * ```ts
- * // With TableDef - only allow filtering by name and email
- * type UserFilter = SimpleWhereInput<typeof usersTable, 'name' | 'email'>;
- *
- * // With Entity class
- * type UserFilter = SimpleWhereInput<User, 'name' | 'email'>;
- *
- * // Request: { "name": { "contains": "john" }, "email": { "endsWith": "@gmail.com" } }
- * ```
- */
-export type SimpleWhereInput<
-  T extends TableDef | EntityConstructor,
-  K extends keyof ExtractColumns<T>
-> = {
-  [P in K]?: ExtractColumns<T>[P] extends ColumnDef<ColumnType, unknown>
-    ? FieldFilter<ExtractColumns<T>[P]>
-    : FieldFilter<ColumnDef<ColumnType, unknown>>;
-};
-
+
+/**
+ * Restricted where input - only specified columns are filterable.
+ * Use this to limit which fields can be filtered via API.
+ *
+ * Works with both TableDef and EntityConstructor.
+ *
+ * @example
+ * ```ts
+ * // With TableDef - only allow filtering by name and email
+ * type UserFilter = SimpleWhereInput<typeof usersTable, 'name' | 'email'>;
+ *
+ * // With Entity class
+ * type UserFilter = SimpleWhereInput<User, 'name' | 'email'>;
+ *
+ * // Request: { "name": { "contains": "john" }, "email": { "endsWith": "@gmail.com" } }
+ * ```
+ */
+export type SimpleWhereInput<
+  T extends TableDef | EntityConstructor,
+  K extends keyof ExtractColumns<T>
+> = {
+  [P in K]?: ExtractColumns<T>[P] extends ColumnDef<ColumnType, unknown>
+    ? FieldFilter<ExtractColumns<T>[P]>
+    : FieldFilter<ColumnDef<ColumnType, unknown>>;
+};
+
 // ─────────────────────────────────────────────────────────────────────────────
 // Relation filter types
 // ─────────────────────────────────────────────────────────────────────────────

package/src/dto/index.ts

@@ -1,95 +1,95 @@
-/**
- * DTO (Data Transfer Object) module for metal-orm.
- *
- * Provides type utilities and runtime helpers for building REST APIs
- * with automatic DTO generation from entity/table definitions.
- *
- * Supports both TableDef and Entity classes as type sources.
- *
- * @example
- * ```ts
- * import { Dto, WithRelations, CreateDto, UpdateDto, SimpleWhereInput, applyFilter, PagedResponse, toPagedResponse } from 'metal-orm/dto';
- *
- * // Using Entity classes
- * type UserResponse = Dto<User, 'passwordHash'>;
- * type PostResponse = Dto<Post, 'authorId'>;
- * type UserWithPosts = WithRelations<UserResponse, { posts: PostResponse[] }>;
- * type CreateUserDto = CreateDto<User>;
- * type UpdateUserDto = UpdateDto<User>;
- * type UserFilter = SimpleWhereInput<User, 'name' | 'email'>;
- *
- * // Enhanced pagination
- * type UsersPagedResponse = PagedResponse<UserResponse>;
- *
- * // Using TableDef directly
- * type UserResponse = Dto<typeof UserTable, 'passwordHash'>;
- * type PostResponse = Dto<typeof PostTable, 'authorId'>;
- * type UserWithPosts = WithRelations<UserResponse, { posts: PostResponse[] }>;
- * type CreateUserDto = CreateDto<typeof UserTable>;
- * type UpdateUserDto = UpdateDto<typeof UserTable>;
- * type UserFilter = SimpleWhereInput<typeof UserTable, 'name' | 'email'>;
- *
- * // Apply filter in controller
- * let query = selectFromEntity(User);
- * query = applyFilter(query, User, where);
- *
- * // Apply enhanced pagination
- * const basic = await qb.executePaged(session, { page: 2, pageSize: 20 });
- * const response = toPagedResponse(basic);
- * // → { items: [...], totalItems: 150, page: 2, pageSize: 20,
- * //     totalPages: 8, hasNextPage: true, hasPrevPage: true }
- * ```
- *
- * @packageDocumentation
- */
-
-// DTO type utilities
-export type {
-  Simplify,
-  Dto,
-  WithRelations,
-  CreateDto,
-  UpdateDto,
-  PagedResponse
-} from './dto-types.js';
-
-// Filter types
-export type {
-  StringFilter,
-  NumberFilter,
-  BooleanFilter,
-  DateFilter,
-  FieldFilter,
-  WhereInput,
-  SimpleWhereInput,
-  FilterOperator,
-  FilterValue,
-  RelationFilter
-} from './filter-types.js';
-
-// Runtime filter application
-export {
-  applyFilter,
-  buildFilterExpression
-} from './apply-filter.js';
-
-// ApplyFilter options type
-export type {
-  ApplyFilterOptions
-} from './apply-filter.js';
-
-// Transformation utilities
-export {
-  toResponse,
-  toResponseBuilder,
-  withDefaults,
-  withDefaultsBuilder,
-  exclude,
-  pick,
-  mapFields
-} from './transform.js';
-
-// Pagination utilities
+/**
+ * DTO (Data Transfer Object) module for metal-orm.
+ *
+ * Provides type utilities and runtime helpers for building REST APIs
+ * with automatic DTO generation from entity/table definitions.
+ *
+ * Supports both TableDef and Entity classes as type sources.
+ *
+ * @example
+ * ```ts
+ * import { Dto, WithRelations, CreateDto, UpdateDto, SimpleWhereInput, applyFilter, PagedResponse, toPagedResponse } from 'metal-orm/dto';
+ *
+ * // Using Entity classes
+ * type UserResponse = Dto<User, 'passwordHash'>;
+ * type PostResponse = Dto<Post, 'authorId'>;
+ * type UserWithPosts = WithRelations<UserResponse, { posts: PostResponse[] }>;
+ * type CreateUserDto = CreateDto<User>;
+ * type UpdateUserDto = UpdateDto<User>;
+ * type UserFilter = SimpleWhereInput<User, 'name' | 'email'>;
+ *
+ * // Enhanced pagination
+ * type UsersPagedResponse = PagedResponse<UserResponse>;
+ *
+ * // Using TableDef directly
+ * type UserResponse = Dto<typeof UserTable, 'passwordHash'>;
+ * type PostResponse = Dto<typeof PostTable, 'authorId'>;
+ * type UserWithPosts = WithRelations<UserResponse, { posts: PostResponse[] }>;
+ * type CreateUserDto = CreateDto<typeof UserTable>;
+ * type UpdateUserDto = UpdateDto<typeof UserTable>;
+ * type UserFilter = SimpleWhereInput<typeof UserTable, 'name' | 'email'>;
+ *
+ * // Apply filter in controller
+ * let query = selectFromEntity(User);
+ * query = applyFilter(query, User, where);
+ *
+ * // Apply enhanced pagination
+ * const basic = await qb.executePaged(session, { page: 2, pageSize: 20 });
+ * const response = toPagedResponse(basic);
+ * // → { items: [...], totalItems: 150, page: 2, pageSize: 20,
+ * //     totalPages: 8, hasNextPage: true, hasPrevPage: true }
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+// DTO type utilities
+export type {
+  Simplify,
+  Dto,
+  WithRelations,
+  CreateDto,
+  UpdateDto,
+  PagedResponse
+} from './dto-types.js';
+
+// Filter types
+export type {
+  StringFilter,
+  NumberFilter,
+  BooleanFilter,
+  DateFilter,
+  FieldFilter,
+  WhereInput,
+  SimpleWhereInput,
+  FilterOperator,
+  FilterValue,
+  RelationFilter
+} from './filter-types.js';
+
+// Runtime filter application
+export {
+  applyFilter,
+  buildFilterExpression
+} from './apply-filter.js';
+
+// ApplyFilter options type
+export type {
+  ApplyFilterOptions
+} from './apply-filter.js';
+
+// Transformation utilities
+export {
+  toResponse,
+  toResponseBuilder,
+  withDefaults,
+  withDefaultsBuilder,
+  exclude,
+  pick,
+  mapFields
+} from './transform.js';
+
+// Pagination utilities
 export {
   toPagedResponse,
   toPagedResponseBuilder,
@@ -107,6 +107,6 @@ export {
 export type {
   ExecuteFilteredPagedOptions
 } from './execute-filtered-paged.js';
-
-// OpenAPI 3.1 Schema generation
-export * from './openapi/index.js';
+
+// OpenAPI 3.1 Schema generation
+export * from './openapi/index.js';

package/src/dto/openapi/generators/base.ts

@@ -1,29 +1,29 @@
-import type { TableDef } from '../../../schema/table.js';
-import type { ColumnDef } from '../../../schema/column-types.js';
-import type { EntityConstructor } from '../../../orm/entity-metadata.js';
-import { getEntityMetadata } from '../../../orm/entity-metadata.js';
-
-export function isTableDef(target: TableDef | EntityConstructor): target is TableDef {
-  return 'columns' in target && 'name' in target;
-}
-
-export function getColumnMap(target: TableDef | EntityConstructor): Record<string, ColumnDef> {
-  if (isTableDef(target)) {
-    return target.columns;
-  }
-  const meta = getEntityMetadata(target);
-  if (meta && meta.columns) {
-    const columns: Record<string, ColumnDef> = {};
-    for (const [key, def] of Object.entries(meta.columns)) {
-      columns[key] = {
-        ...def as object,
-        name: key,
-        table: meta.tableName
-      } as ColumnDef;
-    }
-    return columns;
-  }
-  return {};
-}
-
-export type TargetType<T extends TableDef | EntityConstructor> = T;
+import type { TableDef } from '../../../schema/table.js';
+import type { ColumnDef } from '../../../schema/column-types.js';
+import type { EntityConstructor } from '../../../orm/entity-metadata.js';
+import { getEntityMetadata } from '../../../orm/entity-metadata.js';
+
+export function isTableDef(target: TableDef | EntityConstructor): target is TableDef {
+  return 'columns' in target && 'name' in target;
+}
+
+export function getColumnMap(target: TableDef | EntityConstructor): Record<string, ColumnDef> {
+  if (isTableDef(target)) {
+    return target.columns;
+  }
+  const meta = getEntityMetadata(target);
+  if (meta && meta.columns) {
+    const columns: Record<string, ColumnDef> = {};
+    for (const [key, def] of Object.entries(meta.columns)) {
+      columns[key] = {
+        ...def as object,
+        name: key,
+        table: meta.tableName
+      } as ColumnDef;
+    }
+    return columns;
+  }
+  return {};
+}
+
+export type TargetType<T extends TableDef | EntityConstructor> = T;

package/src/dto/openapi/generators/column.ts

@@ -1,37 +1,37 @@
-import type { ColumnDef } from '../../../schema/column-types.js';
-import type { OpenApiSchema, OpenApiDialect } from '../types.js';
-import { columnTypeToOpenApiType, columnTypeToOpenApiFormat } from '../type-mappings.js';
-import { applyNullability, isNullableColumn } from '../utilities.js';
-
-export function columnToOpenApiSchema(
-  col: ColumnDef,
-  dialect: OpenApiDialect = 'openapi-3.1'
-): OpenApiSchema {
-  const schema: OpenApiSchema = {
-    type: columnTypeToOpenApiType(col),
-    format: columnTypeToOpenApiFormat(col),
-  };
-
-  const nullable = isNullableColumn(col);
-  const result = applyNullability(schema, nullable, dialect);
-
-  if (col.comment) {
-    result.description = col.comment;
-  }
-
-  if (col.type.toUpperCase() === 'ENUM' && col.args && Array.isArray(col.args) && col.args.every(v => typeof v === 'string')) {
-    result.enum = col.args as string[];
-  }
-
-  const args = col.args;
-  if (args && args.length > 0) {
-    if (col.type.toUpperCase() === 'VARCHAR' || col.type.toUpperCase() === 'CHAR') {
-      const length = args[0] as number;
-      if (length) {
-        result.example = 'a'.repeat(length);
-      }
-    }
-  }
-
-  return result;
-}
+import type { ColumnDef } from '../../../schema/column-types.js';
+import type { OpenApiSchema, OpenApiDialect } from '../types.js';
+import { columnTypeToOpenApiType, columnTypeToOpenApiFormat } from '../type-mappings.js';
+import { applyNullability, isNullableColumn } from '../utilities.js';
+
+export function columnToOpenApiSchema(
+  col: ColumnDef,
+  dialect: OpenApiDialect = 'openapi-3.1'
+): OpenApiSchema {
+  const schema: OpenApiSchema = {
+    type: columnTypeToOpenApiType(col),
+    format: columnTypeToOpenApiFormat(col),
+  };
+
+  const nullable = isNullableColumn(col);
+  const result = applyNullability(schema, nullable, dialect);
+
+  if (col.comment) {
+    result.description = col.comment;
+  }
+
+  if (col.type.toUpperCase() === 'ENUM' && col.args && Array.isArray(col.args) && col.args.every(v => typeof v === 'string')) {
+    result.enum = col.args as string[];
+  }
+
+  const args = col.args;
+  if (args && args.length > 0) {
+    if (col.type.toUpperCase() === 'VARCHAR' || col.type.toUpperCase() === 'CHAR') {
+      const length = args[0] as number;
+      if (length) {
+        result.example = 'a'.repeat(length);
+      }
+    }
+  }
+
+  return result;
+}