import { Constructor } from "@decaf-ts/decoration";
import { CascadeMetadata } from "../repository";
import { PersistenceKeys } from "../persistence/constants";

/**
 * Describes join column options.
 */
export type JoinColumnOptions = {
  /**
   * Name of the column.
   */
  name?: string;
  /**
   * Name of the column in the entity to which this column is referenced.
   */
  referencedColumnName?: string;
  /**
   * Name of the foreign key constraint.
   */
  foreignKeyConstraintName?: string;
};

export type JoinTableOptions = {
  /**
   * Name of the table that will be created to store values of the both tables (join table).
   * By default is auto generated.
   */
  name?: string;
  /**
   * First column of the join table.
   */
  joinColumn?: JoinColumnOptions;
  /**
   * Second (inverse) column of the join table.
   */
  inverseJoinColumn?: JoinColumnOptions;
};

export type JoinTableMultipleColumnsOptions = {
  /**
   * Name of the table that will be created to store values of the both tables (join table).
   * By default is auto generated.
   */
  name?: string;
  /**
   * First column of the join table.
   */
  joinColumns?: JoinColumnOptions[];
  /**
   * Second (inverse) column of the join table.
   */
  inverseJoinColumns?: JoinColumnOptions[];
};

export type RelationsMetadata = {
  class: Constructor<any> | (() => Constructor<any>);
  cascade: CascadeMetadata;
  populate: boolean;
  name?: string;
  joinTable?: JoinTableOptions;
};

export type ExtendedRelationsMetadata = RelationsMetadata & {
  key:
    | PersistenceKeys.ONE_TO_ONE
    | PersistenceKeys.ONE_TO_MANY
    | PersistenceKeys.MANY_TO_ONE
    | PersistenceKeys.MANY_TO_MANY;
};