PeerTube/server/core/models/user/user-import.ts

import { AllowNull, BelongsTo, Column, CreatedAt, DataType, ForeignKey, Model, Table, UpdatedAt } from 'sequelize-typescript'
import { MUserImport } from '@server/types/models/index.js'
import { AttributesOnly } from '@peertube/peertube-typescript-utils'
import { UserModel } from './user.js'
import type { UserImportResultSummary, UserImportStateType } from '@peertube/peertube-models'
import { getSort } from '../shared/sort.js'
import { USER_IMPORT_STATES } from '@server/initializers/constants.js'

@Table({
  tableName: 'userImport',
  indexes: [
    {
      fields: [ 'userId' ]
    },
    {
      fields: [ 'filename' ],
      unique: true
    }
  ]
})
export class UserImportModel extends Model<Partial<AttributesOnly<UserImportModel>>> {
  @CreatedAt
  createdAt: Date

  @UpdatedAt
  updatedAt: Date

  @AllowNull(true)
  @Column
  filename: string

  @AllowNull(false)
  @Column
  state: UserImportStateType

  @AllowNull(true)
  @Column(DataType.TEXT)
  error: string

  @AllowNull(true)
  @Column(DataType.JSONB)
  resultSummary: UserImportResultSummary

  @ForeignKey(() => UserModel)
  @Column
  userId: number

  @BelongsTo(() => UserModel, {
    foreignKey: {
      allowNull: false
    },
    onDelete: 'CASCADE'
  })
  User: Awaited<UserModel>

  static load (id: number | string) {
    return UserImportModel.findByPk<MUserImport>(id)
  }

  static loadLatestByUserId (userId: number) {
    return UserImportModel.findOne<MUserImport>({
      where: {
        userId
      },
      order: getSort('-createdAt')
    })
  }

  // ---------------------------------------------------------------------------

  generateAndSetFilename () {
    if (!this.userId) throw new Error('Cannot generate filename without userId')
    if (!this.createdAt) throw new Error('Cannot generate filename without createdAt')

    this.filename = `user-import-${this.userId}-${this.createdAt.toISOString()}.zip`
  }

  toFormattedJSON () {
    return {
      id: this.id,
      state: {
        id: this.state,
        label: USER_IMPORT_STATES[this.state]
      },
      createdAt: this.createdAt.toISOString()
    }
  }
}