user-voucher-group.ts

/**
 *  SudoSOS back-end API service.
 *  Copyright (C) 2024  Study association GEWIS
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 *  @license
 */

/**
 * This is the module page of the user-voucher-group.
 *
 * @module vouchers
 */

import {
  BaseEntity, Entity, JoinColumn, ManyToOne, OneToOne, PrimaryColumn,
} from 'typeorm';
// eslint-disable-next-line import/no-cycle
import User from './user';
// eslint-disable-next-line import/no-cycle
import VoucherGroup from './voucher-group';

/**
 * @typedef {BaseEntity} UserVoucherGroup
 * @property {User.model} user.required - The user that belongs to the group.
 * @property {VoucherGroup.model} voucherGroup.required - The voucherGroup the user
 * belongs to.
 */
@Entity()
export default class UserVoucherGroup extends BaseEntity {
  @PrimaryColumn()
  public userId: number;

  @OneToOne(() => User, { nullable: false })
  @JoinColumn({ name: 'userId' })
  public user: User;

  @ManyToOne(() => VoucherGroup, { nullable: false })
  @JoinColumn()
  public voucherGroup: VoucherGroup;
}