drizzle-orm 0.38.3-791f459 → 0.38.3-8e428d1

package/relations.js

@@ -1,5 +1,4 @@
-import { getTableUniqueName, IsAlias, Schema, Table } from "./table.js";
-import { Columns, getTableName } from "./table.js";
+import { getTableUniqueName, Table } from "./table.js";
 import { Column } from "./column.js";
 import { entityKind, is } from "./entity.js";
 import { PrimaryKeyBuilder } from "./pg-core/primary-keys.js";
@@ -28,508 +27,290 @@ import {
   notLike,
   or
 } from "./sql/expressions/index.js";
-import { Placeholder, SQL, sql } from "./sql/sql.js";
-import { getTableColumns } from "./utils.js";
-class Relations {
-  constructor(schema, tables, config) {
-    this.schema = schema;
-    this.tables = tables;
-    this.config = config;
-    for (const [tsName, table] of Object.entries(tables)) {
-      if (!is(table, Table))
-        continue;
-      this.tableNamesMap[getTableUniqueName(table)] = tsName;
-      const tableConfig = this.tablesConfig[tsName] = {
-        table,
-        tsName,
-        dbName: table[Table.Symbol.Name],
-        schema: table[Table.Symbol.Schema],
-        columns: table[Table.Symbol.Columns],
-        relations: config[tsName] || {},
-        primaryKey: []
-      };
-      for (const column of Object.values(table[Table.Symbol.Columns])) {
-        if (column.primary) {
-          tableConfig.primaryKey.push(column);
-        }
-      }
-      const extraConfig = table[Table.Symbol.ExtraConfigBuilder]?.(table);
-      if (extraConfig) {
-        for (const configEntry of Object.values(extraConfig)) {
-          if (is(configEntry, PrimaryKeyBuilder)) {
-            tableConfig.primaryKey.push(...configEntry.columns);
-          }
-        }
-      }
-    }
-    for (const tableConfig of Object.values(this.tablesConfig)) {
-      for (const [relationFieldName, relation] of Object.entries(tableConfig.relations)) {
-        if (!is(relation, Relation)) {
-          continue;
-        }
-        relation.sourceTable = tableConfig.table;
-        relation.fieldName = relationFieldName;
-      }
-    }
-    for (const tableConfig of Object.values(this.tablesConfig)) {
-      for (const [relationFieldName, relation] of Object.entries(tableConfig.relations)) {
-        const relationPrintName = `relations -> ${tableConfig.tsName}.${relationFieldName}`;
-        if (!is(relation, Relation)) {
-          continue;
-        }
-        if (typeof relation.alias === "string" && !relation.alias) {
-          throw new Error(`${relationPrintName}: "alias" cannot be an empty string - omit it if you don't need it`);
-        }
-        if (relation.sourceColumns?.length === 0) {
-          throw new Error(`${relationPrintName}: "from" cannot be an empty array`);
-        }
-        if (relation.targetColumns?.length === 0) {
-          throw new Error(`${relationPrintName}: "to" cannot be an empty array`);
-        }
-        if (relation.sourceColumns && relation.targetColumns) {
-          if (relation.sourceColumns.length !== relation.targetColumns.length) {
-            throw new Error(
-              `${relationPrintName}: "from" and "to" arrays must have the same length`
-            );
-          }
-          continue;
-        }
-        if (relation.sourceColumns || relation.targetColumns) {
-          throw new Error(
-            `${relationPrintName}: relation must have either both "from" and "to" defined, or none of them`
-          );
-        }
-        let reverseRelation;
-        const targetTableTsName = this.tableNamesMap[getTableUniqueName(relation.targetTable)];
-        if (!targetTableTsName) {
-          throw new Error(
-            `Table "${getTableUniqueName(relation.targetTable)}" not found in provided TS schema`
-          );
-        }
-        const reverseTableConfig = this.tablesConfig[targetTableTsName];
-        if (!reverseTableConfig) {
-          throw new Error(
-            `${relationPrintName}: not enough data provided to build the relation - "from"/"to" are not defined, and no reverse relations of table "${targetTableTsName}" were found"`
-          );
-        }
-        if (relation.alias) {
-          const reverseRelations = Object.values(reverseTableConfig.relations).filter(
-            (it) => is(it, Relation) && it.alias === relation.alias
-          );
-          if (reverseRelations.length > 1) {
-            throw new Error(
-              `${relationPrintName}: not enough data provided to build the relation - "from"/"to" are not defined, and multiple relations with alias "${relation.alias}" found in table "${targetTableTsName}": ${reverseRelations.map((it) => `"${it.fieldName}"`).join(", ")}`
-            );
-          }
-          reverseRelation = reverseRelations[0];
-          if (!reverseRelation) {
-            throw new Error(
-              `${relationPrintName}: not enough data provided to build the relation - "from"/"to" are not defined, and there is no reverse relation of table "${targetTableTsName}" with alias "${relation.alias}"`
-            );
-          }
-        } else {
-          const reverseRelations = Object.values(reverseTableConfig.relations).filter(
-            (it) => is(it, Relation) && it.targetTable === relation.sourceTable && !it.alias
-          );
-          if (reverseRelations.length > 1) {
-            throw new Error(
-              `${relationPrintName}: not enough data provided to build the relation - "from"/"to" are not defined, and multiple relations between "${targetTableTsName}" and "${getTableUniqueName(relation.sourceTable)}" were found.
-Hint: you can specify "alias" on both sides of the relation with the same value`
-            );
-          }
-          reverseRelation = reverseRelations[0];
-          if (!reverseRelation) {
-            throw new Error(
-              `${relationPrintName}: not enough data provided to build the relation - "from"/"to" are not defined, and no reverse relation of table "${targetTableTsName}" with target table "${getTableUniqueName(relation.sourceTable)}" was found`
-            );
-          }
-        }
-        if (!reverseRelation.sourceColumns || !reverseRelation.targetColumns) {
-          throw new Error(
-            `${relationPrintName}: not enough data provided to build the relation - "from"/"to" are not defined, and reverse relation "${targetTableTsName}.${reverseRelation.fieldName}" does not have "from"/"to" defined`
-          );
-        }
-        relation.sourceColumns = reverseRelation.targetColumns;
-        relation.targetColumns = reverseRelation.sourceColumns;
-        relation.where = reverseRelation.where;
-      }
-    }
-  }
-  static [entityKind] = "RelationsV2";
-  /** table DB name -> schema table key */
-  tableNamesMap = {};
-  tablesConfig = {};
-}
+import { SQL, sql } from "./sql/sql.js";
 class Relation {
-  constructor(targetTable) {
-    this.targetTable = targetTable;
+  constructor(sourceTable, referencedTable, relationName) {
+    this.sourceTable = sourceTable;
+    this.referencedTable = referencedTable;
+    this.relationName = relationName;
+    this.referencedTableName = referencedTable[Table.Symbol.Name];
   }
   static [entityKind] = "Relation";
+  referencedTableName;
   fieldName;
-  sourceColumns;
-  targetColumns;
-  alias;
-  where;
-  sourceTable;
+}
+class Relations {
+  constructor(table, config) {
+    this.table = table;
+    this.config = config;
+  }
+  static [entityKind] = "Relations";
 }
 class One extends Relation {
+  constructor(sourceTable, referencedTable, config, isNullable) {
+    super(sourceTable, referencedTable, config?.relationName);
+    this.config = config;
+    this.isNullable = isNullable;
+  }
   static [entityKind] = "One";
-  optional;
-  constructor(targetTable, config) {
-    super(targetTable);
-    this.alias = config?.alias;
-    this.where = config?.where;
-    if (config?.from) {
-      this.sourceColumns = Array.isArray(config.from) ? config.from.map((it) => it._.column) : [config.from._.column];
-    }
-    if (config?.to) {
-      this.targetColumns = Array.isArray(config.to) ? config.to.map((it) => it._.column) : [config.to._.column];
-    }
-    this.optional = config?.optional ?? false;
+  withFieldName(fieldName) {
+    const relation = new One(
+      this.sourceTable,
+      this.referencedTable,
+      this.config,
+      this.isNullable
+    );
+    relation.fieldName = fieldName;
+    return relation;
   }
 }
 class Many extends Relation {
-  constructor(targetTable, config) {
-    super(targetTable);
+  constructor(sourceTable, referencedTable, config) {
+    super(sourceTable, referencedTable, config?.relationName);
     this.config = config;
-    this.alias = config?.alias;
-    this.where = config?.where;
-    if (config?.from) {
-      this.sourceColumns = Array.isArray(config.from) ? config.from.map((it) => it._.column) : [config.from._.column];
-    }
-    if (config?.to) {
-      this.targetColumns = Array.isArray(config.to) ? config.to.map((it) => it._.column) : [config.to._.column];
-    }
   }
   static [entityKind] = "Many";
-}
-class AggregatedField {
-  static [entityKind] = "AggregatedField";
-  table;
-  onTable(table) {
-    this.table = table;
-    return this;
+  withFieldName(fieldName) {
+    const relation = new Many(
+      this.sourceTable,
+      this.referencedTable,
+      this.config
+    );
+    relation.fieldName = fieldName;
+    return relation;
   }
 }
-class Count extends AggregatedField {
-  static [entityKind] = "AggregatedFieldCount";
-  query;
-  getSQL() {
-    if (!this.query) {
-      if (!this.table)
-        throw new Error("Table must be set before building aggregate field");
-      this.query = sql`select count(*) as ${sql.identifier("r")} from ${this.table}`.mapWith(Number);
-    }
-    return this.query;
-  }
+function getOperators() {
+  return {
+    and,
+    between,
+    eq,
+    exists,
+    gt,
+    gte,
+    ilike,
+    inArray,
+    isNull,
+    isNotNull,
+    like,
+    lt,
+    lte,
+    ne,
+    not,
+    notBetween,
+    notExists,
+    notLike,
+    notIlike,
+    notInArray,
+    or,
+    sql
+  };
 }
-const operators = {
-  and,
-  between,
-  eq,
-  exists,
-  gt,
-  gte,
-  ilike,
-  inArray,
-  isNull,
-  isNotNull,
-  like,
-  lt,
-  lte,
-  ne,
-  not,
-  notBetween,
-  notExists,
-  notLike,
-  notIlike,
-  notInArray,
-  or,
-  sql
-};
-const orderByOperators = {
-  sql,
-  asc,
-  desc
-};
 function getOrderByOperators() {
-  return orderByOperators;
+  return {
+    sql,
+    asc,
+    desc
+  };
 }
-function mapRelationalRow(row, buildQueryResultSelection, mapColumnValue = (value) => value, parseJson = false) {
-  for (const selectionItem of buildQueryResultSelection) {
-    const field = selectionItem.field;
-    if (is(field, Table)) {
-      if (row[selectionItem.key] === null)
-        continue;
-      if (parseJson)
-        row[selectionItem.key] = JSON.parse(row[selectionItem.key]);
-      if (selectionItem.isArray) {
-        for (const item of row[selectionItem.key]) {
-          mapRelationalRow(item, selectionItem.selection, mapColumnValue);
+function extractTablesRelationalConfig(schema, configHelpers) {
+  if (Object.keys(schema).length === 1 && "default" in schema && !is(schema["default"], Table)) {
+    schema = schema["default"];
+  }
+  const tableNamesMap = {};
+  const relationsBuffer = {};
+  const tablesConfig = {};
+  for (const [key, value] of Object.entries(schema)) {
+    if (is(value, Table)) {
+      const dbName = getTableUniqueName(value);
+      const bufferedRelations = relationsBuffer[dbName];
+      tableNamesMap[dbName] = key;
+      tablesConfig[key] = {
+        tsName: key,
+        dbName: value[Table.Symbol.Name],
+        schema: value[Table.Symbol.Schema],
+        columns: value[Table.Symbol.Columns],
+        relations: bufferedRelations?.relations ?? {},
+        primaryKey: bufferedRelations?.primaryKey ?? []
+      };
+      for (const column of Object.values(
+        value[Table.Symbol.Columns]
+      )) {
+        if (column.primary) {
+          tablesConfig[key].primaryKey.push(column);
         }
-        continue;
       }
-      mapRelationalRow(
-        row[selectionItem.key],
-        selectionItem.selection,
-        mapColumnValue
+      const extraConfig = value[Table.Symbol.ExtraConfigBuilder]?.(value[Table.Symbol.ExtraConfigColumns]);
+      if (extraConfig) {
+        for (const configEntry of Object.values(extraConfig)) {
+          if (is(configEntry, PrimaryKeyBuilder)) {
+            tablesConfig[key].primaryKey.push(...configEntry.columns);
+          }
+        }
+      }
+    } else if (is(value, Relations)) {
+      const dbName = getTableUniqueName(value.table);
+      const tableName = tableNamesMap[dbName];
+      const relations2 = value.config(
+        configHelpers(value.table)
       );
-      continue;
-    }
-    const value = mapColumnValue(row[selectionItem.key]);
-    if (value === null)
-      continue;
-    let decoder;
-    if (is(field, Column)) {
-      decoder = field;
-    } else if (is(field, SQL)) {
-      decoder = field.decoder;
-    } else if (is(field, SQL.Aliased)) {
-      decoder = field.sql.decoder;
-    } else {
-      decoder = field.getSQL().decoder;
+      let primaryKey;
+      for (const [relationName, relation] of Object.entries(relations2)) {
+        if (tableName) {
+          const tableConfig = tablesConfig[tableName];
+          tableConfig.relations[relationName] = relation;
+          if (primaryKey) {
+            tableConfig.primaryKey.push(...primaryKey);
+          }
+        } else {
+          if (!(dbName in relationsBuffer)) {
+            relationsBuffer[dbName] = {
+              relations: {},
+              primaryKey
+            };
+          }
+          relationsBuffer[dbName].relations[relationName] = relation;
+        }
+      }
     }
-    row[selectionItem.key] = decoder.mapFromDriverValue(value);
   }
-  return row;
+  return { tables: tablesConfig, tableNamesMap };
+}
+function relations(table, relations2) {
+  return new Relations(
+    table,
+    (helpers) => Object.fromEntries(
+      Object.entries(relations2(helpers)).map(([key, value]) => [
+        key,
+        value.withFieldName(key)
+      ])
+    )
+  );
+}
+function createOne(sourceTable) {
+  return function one(table, config) {
+    return new One(
+      sourceTable,
+      table,
+      config,
+      config?.fields.reduce((res, f) => res && f.notNull, true) ?? false
+    );
+  };
 }
-class RelationsBuilderTable {
-  static [entityKind] = "RelationsBuilderTable";
-  _;
-  constructor(table) {
-    this._ = {
-      name: getTableName(table),
-      table
+function createMany(sourceTable) {
+  return function many(referencedTable, config) {
+    return new Many(sourceTable, referencedTable, config);
+  };
+}
+function normalizeRelation(schema, tableNamesMap, relation) {
+  if (is(relation, One) && relation.config) {
+    return {
+      fields: relation.config.fields,
+      references: relation.config.references
     };
   }
-  getSQL() {
-    return this._.table.getSQL();
+  const referencedTableTsName = tableNamesMap[getTableUniqueName(relation.referencedTable)];
+  if (!referencedTableTsName) {
+    throw new Error(
+      `Table "${relation.referencedTable[Table.Symbol.Name]}" not found in schema`
+    );
   }
-}
-class RelationsBuilderColumn {
-  static [entityKind] = "RelationsBuilderColumn";
-  _;
-  constructor(column) {
-    this._ = {
-      tableName: getTableName(column.table),
-      data: void 0,
-      column
-    };
+  const referencedTableConfig = schema[referencedTableTsName];
+  if (!referencedTableConfig) {
+    throw new Error(`Table "${referencedTableTsName}" not found in schema`);
   }
-  through(column) {
-    this._.through = column;
-    return this;
+  const sourceTable = relation.sourceTable;
+  const sourceTableTsName = tableNamesMap[getTableUniqueName(sourceTable)];
+  if (!sourceTableTsName) {
+    throw new Error(
+      `Table "${sourceTable[Table.Symbol.Name]}" not found in schema`
+    );
   }
-  getSQL() {
-    return this._.column.getSQL();
+  const reverseRelations = [];
+  for (const referencedTableRelation of Object.values(
+    referencedTableConfig.relations
+  )) {
+    if (relation.relationName && relation !== referencedTableRelation && referencedTableRelation.relationName === relation.relationName || !relation.relationName && referencedTableRelation.referencedTable === relation.sourceTable) {
+      reverseRelations.push(referencedTableRelation);
+    }
   }
-}
-class RelationsHelperStatic {
-  static [entityKind] = "RelationsHelperStatic";
-  _;
-  constructor(tables) {
-    this._ = {
-      tables
+  if (reverseRelations.length > 1) {
+    throw relation.relationName ? new Error(
+      `There are multiple relations with name "${relation.relationName}" in table "${referencedTableTsName}"`
+    ) : new Error(
+      `There are multiple relations between "${referencedTableTsName}" and "${relation.sourceTable[Table.Symbol.Name]}". Please specify relation name`
+    );
+  }
+  if (reverseRelations[0] && is(reverseRelations[0], One) && reverseRelations[0].config) {
+    return {
+      fields: reverseRelations[0].config.references,
+      references: reverseRelations[0].config.fields
     };
-    const one = {};
-    const many = {};
-    for (const [tableName, table] of Object.entries(tables)) {
-      one[tableName] = (config) => {
-        return new One(table, config);
-      };
-      many[tableName] = (config) => {
-        return new Many(table, config);
-      };
-    }
-    this.one = one;
-    this.many = many;
   }
-  one;
-  many;
-  aggs = {
-    count() {
-      return new Count();
-    }
-  };
-}
-function createRelationsHelper(schema) {
-  const schemaTables = Object.fromEntries(
-    Object.entries(schema).filter((e) => is(e[1], Table))
+  throw new Error(
+    `There is not enough information to infer relation "${sourceTableTsName}.${relation.fieldName}"`
   );
-  const helperStatic = new RelationsHelperStatic(schemaTables);
-  const tables = Object.entries(schema).reduce((acc, [key, value]) => {
-    if (is(value, Table)) {
-      const rTable = new RelationsBuilderTable(value);
-      const columns = Object.entries(getTableColumns(value)).reduce(
-        (acc2, [key2, column]) => {
-          const rbColumn = new RelationsBuilderColumn(column);
-          acc2[key2] = rbColumn;
-          return acc2;
-        },
-        {}
-      );
-      acc[key] = Object.assign(rTable, columns);
-    }
-    return acc;
-  }, {});
-  return Object.assign(helperStatic, tables);
 }
-function defineRelations(schema, relations) {
-  return new Relations(
-    schema,
-    schema,
-    relations(createRelationsHelper(schema))
-  );
-}
-function relationsFieldFilterToSQL(column, filter) {
-  if (typeof filter !== "object" || is(filter, Placeholder))
-    return eq(column, filter);
-  const entries = Object.entries(filter);
-  if (!entries.length)
-    return void 0;
-  const parts = [];
-  for (const [target, value] of entries) {
-    if (value === void 0)
-      continue;
-    switch (target) {
-      case "NOT": {
-        const res = relationsFieldFilterToSQL(column, value);
-        if (!res)
-          continue;
-        parts.push(not(res));
-        continue;
-      }
-      case "OR": {
-        if (!value.length)
-          continue;
-        parts.push(
-          or(
-            ...value.map((subFilter) => relationsFieldFilterToSQL(column, subFilter))
-          )
-        );
-        continue;
-      }
-      default: {
-        parts.push(
-          operators[target](
-            column,
-            value
-          )
-        );
-        continue;
-      }
-    }
-  }
-  if (!parts.length)
-    return void 0;
-  return and(...parts);
+function createTableRelationsHelpers(sourceTable) {
+  return {
+    one: createOne(sourceTable),
+    many: createMany(sourceTable)
+  };
 }
-function relationsFilterToSQL(table, filter) {
-  const entries = Object.entries(filter);
-  if (!entries.length)
-    return void 0;
-  const parts = [];
-  for (const [target, value] of entries) {
-    if (value === void 0)
-      continue;
-    switch (target) {
-      case "RAW": {
-        if (value) {
-          parts.push(
-            value(table[Columns], operators)
-          );
-        }
-        continue;
-      }
-      case "OR": {
-        if (!value?.length)
-          continue;
-        parts.push(
-          or(
-            ...value.map(
-              (subFilter) => relationsFilterToSQL(table, subFilter)
-            )
-          )
-        );
-        continue;
-      }
-      case "NOT": {
-        if (value === void 0)
-          continue;
-        const built = relationsFilterToSQL(table, value);
-        if (!built)
-          continue;
-        parts.push(not(built));
-        continue;
-      }
-      default: {
-        const colFilter = relationsFieldFilterToSQL(
-          table[target],
-          value
-        );
-        if (colFilter)
-          parts.push(colFilter);
-        continue;
+function mapRelationalRow(tablesConfig, tableConfig, row, buildQueryResultSelection, mapColumnValue = (value) => value) {
+  const result = {};
+  for (const [
+    selectionItemIndex,
+    selectionItem
+  ] of buildQueryResultSelection.entries()) {
+    if (selectionItem.isJson) {
+      const relation = tableConfig.relations[selectionItem.tsKey];
+      const rawSubRows = row[selectionItemIndex];
+      const subRows = typeof rawSubRows === "string" ? JSON.parse(rawSubRows) : rawSubRows;
+      result[selectionItem.tsKey] = is(relation, One) ? subRows && mapRelationalRow(
+        tablesConfig,
+        tablesConfig[selectionItem.relationTableTsKey],
+        subRows,
+        selectionItem.selection,
+        mapColumnValue
+      ) : subRows.map(
+        (subRow) => mapRelationalRow(
+          tablesConfig,
+          tablesConfig[selectionItem.relationTableTsKey],
+          subRow,
+          selectionItem.selection,
+          mapColumnValue
+        )
+      );
+    } else {
+      const value = mapColumnValue(row[selectionItemIndex]);
+      const field = selectionItem.field;
+      let decoder;
+      if (is(field, Column)) {
+        decoder = field;
+      } else if (is(field, SQL)) {
+        decoder = field.decoder;
+      } else {
+        decoder = field.sql.decoder;
       }
+      result[selectionItem.tsKey] = value === null ? null : decoder.mapFromDriverValue(value);
     }
   }
-  return and(...parts);
-}
-function relationsOrderToSQL(table, orders) {
-  const data = typeof orders === "function" ? orders(table[Columns], orderByOperators) : orders;
-  return is(data, SQL) ? data : Array.isArray(data) ? data.length ? sql.join(data.map((o) => is(o, SQL) ? o : asc(o)), sql`, `) : void 0 : asc(data);
-}
-function relationExtrasToSQL(table, extras) {
-  const subqueries = [];
-  const selection = [];
-  for (const [key, extra] of Object.entries(
-    typeof extras === "function" ? extras(table[Columns], { sql: operators.sql }) : extras
-  )) {
-    if (!extra)
-      continue;
-    const query = sql`(${extra.getSQL()}) as ${sql.identifier(key)}`;
-    query.decoder = extra.getSQL().decoder;
-    subqueries.push(query);
-    selection.push({
-      key,
-      field: query
-    });
-  }
-  return {
-    sql: subqueries.length ? sql.join(subqueries, sql`, `) : void 0,
-    selection
-  };
-}
-function relationToSQL(relation, sourceTable, targetTable) {
-  const columnWhere = relation.sourceColumns.map((s, i) => {
-    const t = relation.targetColumns[i];
-    return eq(
-      sql`${sql`${sql`${sql.identifier(sourceTable[Schema] ?? "")}.`.if(sourceTable[Schema] && !sourceTable[IsAlias])}`}${sourceTable}.${sql.identifier(s.name)}`,
-      sql`${sql`${sql`${sql.identifier(targetTable[Schema] ?? "")}.`.if(targetTable[Schema] && !targetTable[IsAlias])}`}${targetTable}.${sql.identifier(t.name)}`
-    );
-  });
-  const targetWhere = relation.where ? and(...columnWhere, relationsFilterToSQL(sourceTable, relation.where)) : and(...columnWhere);
-  return targetWhere;
+  return result;
 }
 export {
-  AggregatedField,
-  Count,
   Many,
   One,
   Relation,
   Relations,
-  RelationsBuilderColumn,
-  RelationsBuilderTable,
-  RelationsHelperStatic,
-  createRelationsHelper,
-  defineRelations,
+  createMany,
+  createOne,
+  createTableRelationsHelpers,
+  extractTablesRelationalConfig,
+  getOperators,
   getOrderByOperators,
   mapRelationalRow,
-  operators,
-  orderByOperators,
-  relationExtrasToSQL,
-  relationToSQL,
-  relationsFilterToSQL,
-  relationsOrderToSQL
+  normalizeRelation,
+  relations
 };
 //# sourceMappingURL=relations.js.map