base-entity-without-id.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 base-entity-without-id.
 *
 * @module internal/entities
 */

import {
  BaseEntity as OrmBaseEntity, CreateDateColumn, Index, UpdateDateColumn, VersionColumn,
} from 'typeorm';

/**
 * @typedef BaseEntityWithoutId
 * @property {string} createdAt - The creation date of the object.
 * @property {string} updatedAt - The last update date of the object.
 * @property {integer} version - The current version of the object.
 */
export default class BaseEntityWithoutId extends OrmBaseEntity {
  @Index()
  @CreateDateColumn({ update: false })
  public readonly createdAt: Date;

  @UpdateDateColumn()
  public readonly updatedAt: Date;

  @VersionColumn()
  public readonly version: number;
}