oneuptime/Common/Models/DatabaseModels/DatabaseBaseModel/FileModel.ts

import ColumnAccessControl from "../../../Types/Database/AccessControl/ColumnAccessControl";
import ColumnLength from "../../../Types/Database/ColumnLength";
import ColumnType from "../../../Types/Database/ColumnType";
import SlugifyColumn from "../../../Types/Database/SlugifyColumn";
import TableColumn from "../../../Types/Database/TableColumn";
import TableColumnType from "../../../Types/Database/TableColumnType";
import MimeType from "../../../Types/File/MimeType";
import ObjectID from "../../../Types/ObjectID";
import Permission from "../../../Types/Permission";
import BaseModel from "./DatabaseBaseModel";
import { Column } from "typeorm";

@SlugifyColumn("name", "slug")
export default class FileModel extends BaseModel {
  public constructor(id?: ObjectID) {
    super(id);
  }

  public override isFileModel(): boolean {
    return true;
  }

  @ColumnAccessControl({
    create: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    read: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    update: [],
  })
  @TableColumn({
    required: true,
    type: TableColumnType.File,
    canReadOnRelationQuery: true,
  })
  @Column({
    nullable: false,
    type: ColumnType.File,
  })
  public file?: Buffer = undefined;

  @ColumnAccessControl({
    create: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    read: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    update: [],
  })
  @TableColumn({
    required: true,
    type: TableColumnType.ShortText,
    title: "Name",
    description: "Any friendly name of this object",
    canReadOnRelationQuery: true,
  })
  @Column({
    nullable: false,
    type: ColumnType.ShortText,
    length: ColumnLength.ShortText,
  })
  public name?: string = undefined;

  @ColumnAccessControl({
    create: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    read: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    update: [],
  })
  @TableColumn({
    required: true,
    type: TableColumnType.ShortText,
    canReadOnRelationQuery: true,
  })
  @Column({
    nullable: false,
    type: ColumnType.ShortText,
    length: ColumnLength.ShortText,
  })
  public fileType?: MimeType = undefined;

  @ColumnAccessControl({
    create: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    read: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    update: [],
  })
  @TableColumn({
    required: true,
    unique: true,
    type: TableColumnType.Slug,
    canReadOnRelationQuery: true,
  })
  @Column({
    nullable: false,
    type: ColumnType.Slug,
    length: ColumnLength.Slug,
  })
  public slug?: string = undefined;

  @ColumnAccessControl({
    create: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    read: [Permission.CurrentUser, Permission.AuthenticatedRequest],
    update: [],
  })
  @TableColumn({
    required: true,
    isDefaultValueColumn: true,
    type: TableColumnType.Slug,
    canReadOnRelationQuery: true,
  })
  @Column({
    nullable: false,
    default: true,
    type: ColumnType.Slug,
    length: ColumnLength.Slug,
  })
  public isPublic?: boolean = undefined;
}