metal-orm 1.0.90 → 1.0.92

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metal-orm",
-  "version": "1.0.90",
+  "version": "1.0.92",
   "type": "module",
   "types": "./dist/index.d.ts",
   "engines": {
@@ -59,7 +59,6 @@
     }
   },
   "devDependencies": {
-    "@electric-sql/pglite": "^0.3.14",
     "@typescript-eslint/eslint-plugin": "^8.20.0",
     "@typescript-eslint/parser": "^8.20.0",
     "@vitest/ui": "^4.0.14",
@@ -75,5 +74,8 @@
     "tsup": "^8.0.0",
     "typescript": "^5.5.0",
     "vitest": "^4.0.14"
+  },
+  "dependencies": {
+    "@electric-sql/pglite": "^0.3.14"
   }
 }

package/scripts/generate-entities/render.mjs

@@ -4,6 +4,14 @@ import { buildSchemaMetadata } from './schema.mjs';
 
 const escapeJsString = value => value.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
 
+const sanitizePropertyName = columnName => {
+  if (!columnName) return '';
+  return columnName
+    .replace(/\s+/g, '_')
+    .replace(/[^a-zA-Z0-9_$]/g, '_')
+    .replace(/^[0-9]/, '_$&');
+};
+
 const formatJsDoc = comment => {
   if (!comment) return null;
   const normalized = comment.replace(/\r\n?/g, '\n').trim();
@@ -159,7 +167,7 @@ const buildColumnDoc = column => {
   return entries.join('\n');
 };
 
-const renderColumnExpression = (column, tablePk, tableSchema, defaultSchema) => {
+const renderColumnExpression = (column, tablePk, tableSchema, defaultSchema, propertyName) => {
   const base = parseColumnType(column.type);
   let expr = base.factory;
 
@@ -198,6 +206,10 @@ const renderColumnExpression = (column, tablePk, tableSchema, defaultSchema) =>
   const tsType = base.ts || 'any';
   const optional = !column.notNull;
 
+  if (column.name !== propertyName) {
+    expr = `{ ...${expr}, name: '${escapeJsString(column.name)}' }`;
+  }
+
   return {
     decorator,
     expr,
@@ -236,10 +248,11 @@ const renderEntityClassLines = ({ table, className, naming, relations, resolveCl
   lines.push(`export class ${className} {`);
 
   for (const col of table.columns) {
-    const rendered = renderColumnExpression(col, table.primaryKey, table.schema, defaultSchema);
+    const propertyName = sanitizePropertyName(col.name);
+    const rendered = renderColumnExpression(col, table.primaryKey, table.schema, defaultSchema, propertyName);
     appendJsDoc(lines, rendered.comment, '  ');
     lines.push(`  @${rendered.decorator}(${rendered.expr})`);
-    lines.push(`  ${col.name}${rendered.optional ? '?:' : '!:'} ${rendered.tsType};`);
+    lines.push(`  ${propertyName}${rendered.optional ? '?:' : '!:'} ${rendered.tsType};`);
     lines.push('');
   }
 

package/src/core/ddl/introspect/utils.ts

@@ -1,45 +1,45 @@
-import { DbExecutor, QueryResult } from '../../execution/db-executor.js';
-import { IntrospectOptions } from './types.js';
-
-/**
- * Converts a query result to an array of row objects.
- * @param result - The query result.
- * @returns The array of rows.
- */
-export const toRows = (result: QueryResult | undefined): Record<string, unknown>[] => {
-  if (!result) return [];
-  return result.values.map(row =>
-    result.columns.reduce<Record<string, unknown>>((acc, col, idx) => {
-      acc[col] = row[idx];
-      return acc;
-    }, {})
-  );
-};
-
-/**
- * Executes a SQL query and returns the rows.
- * @param executor - The database executor.
- * @param sql - The SQL query.
- * @param params - The query parameters.
- * @returns The array of rows.
- */
-export const queryRows = async (
-  executor: DbExecutor,
-  sql: string,
-  params: unknown[] = []
-): Promise<Record<string, unknown>[]> => {
-  const [first] = await executor.executeSql(sql, params);
-  return toRows(first);
-};
-
-/**
- * Checks if a table should be included in introspection based on options.
- * @param name - The table name.
- * @param options - The introspection options.
- * @returns True if the table should be included.
- */
-export const shouldIncludeTable = (name: string, options: IntrospectOptions): boolean => {
-  if (options.includeTables && !options.includeTables.includes(name)) return false;
-  if (options.excludeTables && options.excludeTables.includes(name)) return false;
-  return true;
-};
+import { DbExecutor, QueryResult } from '../../execution/db-executor.js';
+import { IntrospectOptions } from './types.js';
+
+/**
+ * Converts a query result to an array of row objects.
+ * @param result - The query result.
+ * @returns The array of rows.
+ */
+export const toRows = (result: QueryResult | undefined): Record<string, unknown>[] => {
+  if (!result) return [];
+  return result.values.map(row =>
+    result.columns.reduce<Record<string, unknown>>((acc, col, idx) => {
+      acc[col] = row[idx];
+      return acc;
+    }, {})
+  );
+};
+
+/**
+ * Executes a SQL query and returns the rows.
+ * @param executor - The database executor.
+ * @param sql - The SQL query.
+ * @param params - The query parameters.
+ * @returns The array of rows.
+ */
+export const queryRows = async (
+  executor: DbExecutor,
+  sql: string,
+  params: unknown[] = []
+): Promise<Record<string, unknown>[]> => {
+  const [first] = await executor.executeSql(sql, params);
+  return toRows(first);
+};
+
+/**
+ * Checks if a table should be included in introspection based on options.
+ * @param name - The table name.
+ * @param options - The introspection options.
+ * @returns True if the table should be included.
+ */
+export const shouldIncludeTable = (name: string, options: IntrospectOptions): boolean => {
+  if (options.includeTables && !options.includeTables.includes(name)) return false;
+  if (options.excludeTables && options.excludeTables.includes(name)) return false;
+  return true;
+};

package/src/decorators/bootstrap.ts

@@ -176,17 +176,17 @@ export const bootstrapEntities = (): TableDef[] => {
  * @param ctor - The entity constructor.
  * @returns The table definition or undefined if not found.
  */
-export const getTableDefFromEntity = <TTable extends TableDef = TableDef>(ctor: EntityConstructor): TTable | undefined => {
-  const meta = getEntityMetadata(ctor);
-  if (!meta) return undefined;
-  if (!meta.table) {
-    bootstrapEntities();
-  }
-  if (!meta.table) {
-    throw new Error(`Failed to build table definition for entity '${ctor.name}'`);
-  }
-  return meta.table as TTable;
-};
+export const getTableDefFromEntity = <TTable extends TableDef = TableDef>(ctor: EntityConstructor): TTable | undefined => {
+  const meta = getEntityMetadata(ctor);
+  if (!meta) return undefined;
+  if (!meta.table) {
+    bootstrapEntities();
+  }
+  if (!meta.table) {
+    throw new Error(`Failed to build table definition for entity '${ctor.name}'`);
+  }
+  return meta.table as TTable;
+};
 
 /**
  * Creates a select query builder for the given entity.
@@ -248,29 +248,29 @@ export const selectFromEntity = <TEntity extends object>(
  * Lazily bootstraps entity metadata (via getTableDefFromEntity) and returns a
  * `tableRef(...)`-style proxy so users can write `u.id` instead of `u.columns.id`.
  */
-export const entityRef = <TEntity extends object>(
-  ctor: EntityConstructor<TEntity>
-): TableRef<EntityTable<TEntity>> => {
-  const table = getTableDefFromEntity(ctor);
-  if (!table) {
-    throw new Error(`Entity '${ctor.name}' is not registered with decorators or has not been bootstrapped`);
-  }
-  return tableRef(table as EntityTable<TEntity>);
-};
-
-type EntityRefsTuple<T extends readonly EntityConstructor<object>[]> = {
-  [K in keyof T]: T[K] extends EntityConstructor<infer TEntity>
-  ? TableRef<EntityTable<TEntity & object>>
-  : never;
-};
-
-/**
- * Public API: variadic entity references.
- * Usage:
- *   const [u, p] = entityRefs(User, Post);
- */
-export const entityRefs = <T extends readonly EntityConstructor<object>[]>(
-  ...ctors: T
-): EntityRefsTuple<T> => {
-  return ctors.map(ctor => entityRef(ctor)) as EntityRefsTuple<T>;
-};
+export const entityRef = <TEntity extends object>(
+  ctor: EntityConstructor<TEntity>
+): TableRef<EntityTable<TEntity>> => {
+  const table = getTableDefFromEntity(ctor);
+  if (!table) {
+    throw new Error(`Entity '${ctor.name}' is not registered with decorators or has not been bootstrapped`);
+  }
+  return tableRef(table as EntityTable<TEntity>);
+};
+
+type EntityRefsTuple<T extends readonly EntityConstructor<object>[]> = {
+  [K in keyof T]: T[K] extends EntityConstructor<infer TEntity>
+  ? TableRef<EntityTable<TEntity & object>>
+  : never;
+};
+
+/**
+ * Public API: variadic entity references.
+ * Usage:
+ *   const [u, p] = entityRefs(User, Post);
+ */
+export const entityRefs = <T extends readonly EntityConstructor<object>[]>(
+  ...ctors: T
+): EntityRefsTuple<T> => {
+  return ctors.map(ctor => entityRef(ctor)) as EntityRefsTuple<T>;
+};

package/src/decorators/column-decorator.ts

@@ -12,6 +12,7 @@ export interface ColumnOptions {
   notNull?: boolean;
   primary?: boolean;
   tsType?: ColumnDef['tsType'];
+  name?: string;
 }
 
 /**
@@ -35,7 +36,8 @@ const normalizeColumnInput = (input: ColumnInput): ColumnDefLike => {
     generated: asDefinition.generated,
     check: asDefinition.check,
     references: asDefinition.references,
-    comment: asDefinition.comment
+    comment: asDefinition.comment,
+    name: asOptions.name ?? asDefinition.name
   };
 
   if (!column.type) {