misskey/packages/backend/src/models/User.ts

294 lines
6.6 KiB
TypeScript

/*
* SPDX-FileCopyrightText: syuilo and misskey-project
* SPDX-License-Identifier: AGPL-3.0-only
*/
import { Entity, Column, Index, OneToOne, JoinColumn, PrimaryColumn } from 'typeorm';
import { id } from './util/id.js';
import { MiDriveFile } from './DriveFile.js';
@Entity('user')
@Index(['usernameLower', 'host'], { unique: true })
export class MiUser {
@PrimaryColumn(id())
public id: string;
@Index()
@Column('timestamp with time zone', {
nullable: true,
comment: 'The updated date of the User.',
})
public updatedAt: Date | null;
@Column('timestamp with time zone', {
nullable: true,
})
public lastFetchedAt: Date | null;
@Index()
@Column('timestamp with time zone', {
nullable: true,
})
public lastActiveDate: Date | null;
@Column('boolean', {
default: false,
})
public hideOnlineStatus: boolean;
@Column('varchar', {
length: 128,
comment: 'The username of the User.',
})
public username: string;
@Index()
@Column('varchar', {
length: 128, select: false,
comment: 'The username (lowercased) of the User.',
})
public usernameLower: string;
@Column('varchar', {
length: 128, nullable: true,
comment: 'The name of the User.',
})
public name: string | null;
@Column('integer', {
default: 0,
comment: 'The count of followers.',
})
public followersCount: number;
@Column('integer', {
default: 0,
comment: 'The count of following.',
})
public followingCount: number;
@Column('varchar', {
length: 512,
nullable: true,
comment: 'The URI of the new account of the User',
})
public movedToUri: string | null;
@Column('timestamp with time zone', {
nullable: true,
comment: 'When the user moved to another account',
})
public movedAt: Date | null;
@Column('simple-array', {
nullable: true,
comment: 'URIs the user is known as too',
})
public alsoKnownAs: string[] | null;
@Column('integer', {
default: 0,
comment: 'The count of notes.',
})
public notesCount: number;
@Column({
...id(),
nullable: true,
comment: 'The ID of avatar DriveFile.',
})
public avatarId: MiDriveFile['id'] | null;
@OneToOne(type => MiDriveFile, {
onDelete: 'SET NULL',
})
@JoinColumn()
public avatar: MiDriveFile | null;
@Column({
...id(),
nullable: true,
comment: 'The ID of banner DriveFile.',
})
public bannerId: MiDriveFile['id'] | null;
@OneToOne(type => MiDriveFile, {
onDelete: 'SET NULL',
})
@JoinColumn()
public banner: MiDriveFile | null;
@Column('varchar', {
length: 512, nullable: true,
})
public avatarUrl: string | null;
@Column('varchar', {
length: 512, nullable: true,
})
public bannerUrl: string | null;
@Column('varchar', {
length: 128, nullable: true,
})
public avatarBlurhash: string | null;
@Column('varchar', {
length: 128, nullable: true,
})
public bannerBlurhash: string | null;
@Column('jsonb', {
default: [],
})
public avatarDecorations: {
id: string;
angle?: number;
flipH?: boolean;
offsetX?: number;
offsetY?: number;
}[];
@Index()
@Column('varchar', {
length: 128, array: true, default: '{}',
})
public tags: string[];
@Column('boolean', {
default: false,
comment: 'Whether the User is suspended.',
})
public isSuspended: boolean;
@Column('boolean', {
default: false,
comment: 'Whether the User is locked.',
})
public isLocked: boolean;
@Column('boolean', {
default: false,
comment: 'Whether the User is a bot.',
})
public isBot: boolean;
@Column('boolean', {
default: false,
comment: 'Whether the User is a cat.',
})
public isCat: boolean;
@Column('boolean', {
default: false,
comment: 'Whether the User is the root.',
})
public isRoot: boolean;
@Index()
@Column('boolean', {
default: true,
comment: 'Whether the User is explorable.',
})
public isExplorable: boolean;
@Column('boolean', {
default: false,
})
public isHibernated: boolean;
// アカウントが削除されたかどうかのフラグだが、完全に削除される際は物理削除なので実質削除されるまでの「削除が進行しているかどうか」のフラグ
@Column('boolean', {
default: false,
comment: 'Whether the User is deleted.',
})
public isDeleted: boolean;
@Column('varchar', {
length: 128, array: true, default: '{}',
})
public emojis: string[];
@Index()
@Column('varchar', {
length: 128, nullable: true,
comment: 'The host of the User. It will be null if the origin of the user is local.',
})
public host: string | null;
@Column('varchar', {
length: 512, nullable: true,
comment: 'The inbox URL of the User. It will be null if the origin of the user is local.',
})
public inbox: string | null;
@Column('varchar', {
length: 512, nullable: true,
comment: 'The sharedInbox URL of the User. It will be null if the origin of the user is local.',
})
public sharedInbox: string | null;
@Column('varchar', {
length: 512, nullable: true,
comment: 'The featured URL of the User. It will be null if the origin of the user is local.',
})
public featured: string | null;
@Index()
@Column('varchar', {
length: 512, nullable: true,
comment: 'The URI of the User. It will be null if the origin of the user is local.',
})
public uri: string | null;
@Column('varchar', {
length: 512, nullable: true,
comment: 'The URI of the user Follower Collection. It will be null if the origin of the user is local.',
})
public followersUri: string | null;
@Index({ unique: true })
@Column('char', {
length: 16, nullable: true, unique: true,
comment: 'The native access token of the User. It will be null if the origin of the user is local.',
})
public token: string | null;
constructor(data: Partial<MiUser>) {
if (data == null) return;
for (const [k, v] of Object.entries(data)) {
(this as any)[k] = v;
}
}
}
export type MiLocalUser = MiUser & {
host: null;
uri: null;
}
export type MiPartialLocalUser = Partial<MiUser> & {
id: MiUser['id'];
host: null;
uri: null;
}
export type MiRemoteUser = MiUser & {
host: string;
uri: string;
}
export type MiPartialRemoteUser = Partial<MiUser> & {
id: MiUser['id'];
host: string;
uri: string;
}
export const localUsernameSchema = { type: 'string', pattern: /^\w{1,20}$/.toString().slice(1, -1) } as const;
export const passwordSchema = { type: 'string', minLength: 1 } as const;
export const nameSchema = { type: 'string', minLength: 1, maxLength: 50 } as const;
export const descriptionSchema = { type: 'string', minLength: 1, maxLength: 1500 } as const;
export const locationSchema = { type: 'string', minLength: 1, maxLength: 50 } as const;
export const birthdaySchema = { type: 'string', pattern: /^([0-9]{4})-([0-9]{2})-([0-9]{2})$/.toString().slice(1, -1) } as const;