aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/types/models/user/user.ts
blob: 89092c242625912e55c13197cc65b9cf95d8cbd6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
import { AccountModel } from '@server/models/account/account'
import { UserModel } from '@server/models/user/user'
import { MVideoPlaylist } from '@server/types/models'
import { PickWith, PickWithOpt } from '@shared/typescript-utils'
import {
  MAccount,
  MAccountDefault,
  MAccountDefaultChannelDefault,
  MAccountFormattable,
  MAccountId,
  MAccountIdActorId,
  MAccountUrl
} from '../account'
import { MChannelFormattable } from '../video/video-channels'
import { MNotificationSetting, MNotificationSettingFormattable } from './user-notification-setting'

type Use<K extends keyof UserModel, M> = PickWith<UserModel, K, M>

// ############################################################################

export type MUser = Omit<UserModel, 'Account' | 'NotificationSetting' | 'VideoImports' | 'OAuthTokens'>

// ############################################################################

export type MUserQuotaUsed = MUser & { videoQuotaUsed?: number, videoQuotaUsedDaily?: number }
export type MUserId = Pick<UserModel, 'id'>

// ############################################################################

// With account

export type MUserAccountId =
  MUser &
  Use<'Account', MAccountId>

export type MUserAccountUrl =
  MUser &
  Use<'Account', MAccountUrl & MAccountIdActorId>

export type MUserAccount =
  MUser &
  Use<'Account', MAccount>

export type MUserAccountDefault =
  MUser &
  Use<'Account', MAccountDefault>

// With channel

export type MUserNotifSettingChannelDefault =
  MUser &
  Use<'NotificationSetting', MNotificationSetting> &
  Use<'Account', MAccountDefaultChannelDefault>

// With notification settings

export type MUserWithNotificationSetting =
  MUser &
  Use<'NotificationSetting', MNotificationSetting>

export type MUserNotifSettingAccount =
  MUser &
  Use<'NotificationSetting', MNotificationSetting> &
  Use<'Account', MAccount>

// Default scope

export type MUserDefault =
  MUser &
  Use<'NotificationSetting', MNotificationSetting> &
  Use<'Account', MAccountDefault>

// ############################################################################

// Format for API or AP object

type MAccountWithChannels = MAccountFormattable & PickWithOpt<AccountModel, 'VideoChannels', MChannelFormattable[]>
type MAccountWithChannelsAndSpecialPlaylists =
  MAccountWithChannels &
  PickWithOpt<AccountModel, 'VideoPlaylists', MVideoPlaylist[]>

export type MUserFormattable =
  MUserQuotaUsed &
  Use<'Account', MAccountWithChannels> &
  PickWithOpt<UserModel, 'NotificationSetting', MNotificationSettingFormattable>

export type MMyUserFormattable =
  MUserFormattable &
  Use<'Account', MAccountWithChannelsAndSpecialPlaylists>