chore: Typescript database models (#2886)

closes #2798

server/models/FileOperation.ts

@@ -1,76 +1,88 @@
+import {
+  ForeignKey,
+  DefaultScope,
+  Column,
+  BeforeDestroy,
+  BelongsTo,
+  Table,
+  DataType,
+} from "sequelize-typescript";
 import { deleteFromS3 } from "@server/utils/s3";
-import { DataTypes, sequelize } from "../sequelize";
+import Collection from "./Collection";
+import Team from "./Team";
+import User from "./User";
+import BaseModel from "./base/BaseModel";
+import Fix from "./decorators/Fix";
 
-const FileOperation = sequelize.define("file_operations", {
-  id: {
-    type: DataTypes.UUID,
-    defaultValue: DataTypes.UUIDV4,
-    primaryKey: true,
-  },
-  type: {
-    type: DataTypes.ENUM("import", "export"),
-    allowNull: false,
-  },
-  state: {
-    type: DataTypes.ENUM(
-      "creating",
-      "uploading",
-      "complete",
-      "error",
-      "expired"
-    ),
-    allowNull: false,
-  },
-  key: {
-    type: DataTypes.STRING,
-  },
-  url: {
-    type: DataTypes.STRING,
-  },
-  size: {
-    type: DataTypes.BIGINT,
-    allowNull: false,
-  },
-});
-// @ts-expect-error ts-migrate(7006) FIXME: Parameter 'model' implicitly has an 'any' type.
-FileOperation.beforeDestroy(async (model) => {
-  await deleteFromS3(model.key);
-});
+@DefaultScope(() => ({
+  include: [
+    {
+      model: User,
+      as: "user",
+      paranoid: false,
+    },
+    {
+      model: Collection,
+      as: "collection",
+      paranoid: false,
+    },
+  ],
+}))
+@Table({ tableName: "file_operations", modelName: "file_operation" })
+@Fix
+class FileOperation extends BaseModel {
+  @Column(DataType.ENUM("import", "export"))
+  type: "import" | "export";
 
-FileOperation.prototype.expire = async function () {
-  this.state = "expired";
-  await deleteFromS3(this.key);
-  await this.save();
-};
+  @Column(
+    DataType.ENUM("creating", "uploading", "complete", "error", "expired")
+  )
+  state: "creating" | "uploading" | "complete" | "error" | "expired";
 
-// @ts-expect-error ts-migrate(7006) FIXME: Parameter 'models' implicitly has an 'any' type.
-FileOperation.associate = (models) => {
-  FileOperation.belongsTo(models.User, {
-    as: "user",
-    foreignKey: "userId",
-  });
-  FileOperation.belongsTo(models.Collection, {
-    as: "collection",
-    foreignKey: "collectionId",
-  });
-  FileOperation.belongsTo(models.Team, {
-    as: "team",
-    foreignKey: "teamId",
-  });
-  FileOperation.addScope("defaultScope", {
-    include: [
-      {
-        model: models.User,
-        as: "user",
-        paranoid: false,
-      },
-      {
-        model: models.Collection,
-        as: "collection",
-        paranoid: false,
-      },
-    ],
-  });
-};
+  @Column
+  key: string;
+
+  @Column
+  url: string;
+
+  @Column(DataType.BIGINT)
+  size: number;
+
+  expire = async function () {
+    this.state = "expired";
+    await deleteFromS3(this.key);
+    await this.save();
+  };
+
+  // hooks
+
+  @BeforeDestroy
+  static async deleteFileFromS3(model: FileOperation) {
+    await deleteFromS3(model.key);
+  }
+
+  // associations
+
+  @BelongsTo(() => User, "userId")
+  user: User;
+
+  @ForeignKey(() => User)
+  @Column(DataType.UUID)
+  userId: string;
+
+  @BelongsTo(() => Team, "teamId")
+  team: Team;
+
+  @ForeignKey(() => Team)
+  @Column(DataType.UUID)
+  teamId: string;
+
+  @BelongsTo(() => Collection, "collectionId")
+  collection: Collection;
+
+  @ForeignKey(() => Collection)
+  @Column(DataType.UUID)
+  collectionId: string;
+}
 
 export default FileOperation;