Split types and typings

5 files changed, 199 insertions, 0 deletions

diff --git a/server/types/models/user/index.ts b/server/types/models/user/index.ts
new file mode 100644
index 000000000..6657b2128
--- /dev/null
+++ b/server/types/models/user/index.ts
@@ -0,0 +1,4 @@
+export * from './user'
+export * from './user-notification'
+export * from './user-notification-setting'
+export * from './user-video-history'
diff --git a/server/types/models/user/user-notification-setting.ts b/server/types/models/user/user-notification-setting.ts
new file mode 100644
index 000000000..c674add1b
--- /dev/null
+++ b/server/types/models/user/user-notification-setting.ts
@@ -0,0 +1,9 @@
+import { UserNotificationSettingModel } from '@server/models/account/user-notification-setting'
+
+export type MNotificationSetting = Omit<UserNotificationSettingModel, 'User'>
+
+// ############################################################################
+
+// Format for API or AP object
+
+export type MNotificationSettingFormattable = MNotificationSetting
diff --git a/server/types/models/user/user-notification.ts b/server/types/models/user/user-notification.ts
new file mode 100644
index 000000000..2080360e1
--- /dev/null
+++ b/server/types/models/user/user-notification.ts
@@ -0,0 +1,92 @@
+import { UserNotificationModel } from '../../../models/account/user-notification'
+import { PickWith, PickWithOpt } from '../../utils'
+import { VideoModel } from '../../../models/video/video'
+import { ActorModel } from '../../../models/activitypub/actor'
+import { ServerModel } from '../../../models/server/server'
+import { AvatarModel } from '../../../models/avatar/avatar'
+import { VideoChannelModel } from '../../../models/video/video-channel'
+import { AccountModel } from '../../../models/account/account'
+import { VideoCommentModel } from '../../../models/video/video-comment'
+import { VideoAbuseModel } from '../../../models/video/video-abuse'
+import { VideoBlacklistModel } from '../../../models/video/video-blacklist'
+import { VideoImportModel } from '../../../models/video/video-import'
+import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
+
+type Use<K extends keyof UserNotificationModel, M> = PickWith<UserNotificationModel, K, M>
+
+// ############################################################################
+
+export module UserNotificationIncludes {
+
+  export type VideoInclude = Pick<VideoModel, 'id' | 'uuid' | 'name'>
+  export type VideoIncludeChannel =
+    VideoInclude &
+    PickWith<VideoModel, 'VideoChannel', VideoChannelIncludeActor>
+
+  export type ActorInclude =
+    Pick<ActorModel, 'preferredUsername' | 'getHost'> &
+    PickWith<ActorModel, 'Avatar', Pick<AvatarModel, 'filename' | 'getStaticPath'>> &
+    PickWith<ActorModel, 'Server', Pick<ServerModel, 'host'>>
+
+  export type VideoChannelInclude = Pick<VideoChannelModel, 'id' | 'name' | 'getDisplayName'>
+  export type VideoChannelIncludeActor =
+    VideoChannelInclude &
+    PickWith<VideoChannelModel, 'Actor', ActorInclude>
+
+  export type AccountInclude = Pick<AccountModel, 'id' | 'name' | 'getDisplayName'>
+  export type AccountIncludeActor =
+    AccountInclude &
+    PickWith<AccountModel, 'Actor', ActorInclude>
+
+  export type VideoCommentInclude =
+    Pick<VideoCommentModel, 'id' | 'originCommentId' | 'getThreadId'> &
+    PickWith<VideoCommentModel, 'Account', AccountIncludeActor> &
+    PickWith<VideoCommentModel, 'Video', VideoInclude>
+
+  export type VideoAbuseInclude =
+    Pick<VideoAbuseModel, 'id'> &
+    PickWith<VideoAbuseModel, 'Video', VideoInclude>
+
+  export type VideoBlacklistInclude =
+    Pick<VideoBlacklistModel, 'id'> &
+    PickWith<VideoAbuseModel, 'Video', VideoInclude>
+
+  export type VideoImportInclude =
+    Pick<VideoImportModel, 'id' | 'magnetUri' | 'targetUrl' | 'torrentName'> &
+    PickWith<VideoImportModel, 'Video', VideoInclude>
+
+  export type ActorFollower =
+    Pick<ActorModel, 'preferredUsername' | 'getHost'> &
+    PickWith<ActorModel, 'Account', AccountInclude> &
+    PickWith<ActorModel, 'Server', Pick<ServerModel, 'host'>> &
+    PickWithOpt<ActorModel, 'Avatar', Pick<AvatarModel, 'filename' | 'getStaticPath'>>
+
+  export type ActorFollowing =
+    Pick<ActorModel, 'preferredUsername' | 'type' | 'getHost'> &
+    PickWith<ActorModel, 'VideoChannel', VideoChannelInclude> &
+    PickWith<ActorModel, 'Account', AccountInclude> &
+    PickWith<ActorModel, 'Server', Pick<ServerModel, 'host'>>
+
+  export type ActorFollowInclude =
+    Pick<ActorFollowModel, 'id' | 'state'> &
+    PickWith<ActorFollowModel, 'ActorFollower', ActorFollower> &
+    PickWith<ActorFollowModel, 'ActorFollowing', ActorFollowing>
+}
+
+// ############################################################################
+
+export type MUserNotification =
+  Omit<UserNotificationModel, 'User' | 'Video' | 'Comment' | 'VideoAbuse' | 'VideoBlacklist' |
+  'VideoImport' | 'Account' | 'ActorFollow'>
+
+// ############################################################################
+
+export type UserNotificationModelForApi =
+  MUserNotification &
+  Use<'Video', UserNotificationIncludes.VideoIncludeChannel> &
+  Use<'Comment', UserNotificationIncludes.VideoCommentInclude> &
+  Use<'VideoAbuse', UserNotificationIncludes.VideoAbuseInclude> &
+  Use<'VideoBlacklist', UserNotificationIncludes.VideoBlacklistInclude> &
+  Use<'VideoImport', UserNotificationIncludes.VideoImportInclude> &
+  Use<'ActorFollow', UserNotificationIncludes.ActorFollowInclude> &
+  Use<'Account', UserNotificationIncludes.AccountIncludeActor>
diff --git a/server/types/models/user/user-video-history.ts b/server/types/models/user/user-video-history.ts
new file mode 100644
index 000000000..62673ab1b
--- /dev/null
+++ b/server/types/models/user/user-video-history.ts
@@ -0,0 +1,5 @@
+import { UserVideoHistoryModel } from '../../../models/account/user-video-history'
+
+export type MUserVideoHistory = Omit<UserVideoHistoryModel, 'Video' | 'User'>
+
+export type MUserVideoHistoryTime = Pick<MUserVideoHistory, 'currentTime'>
diff --git a/server/types/models/user/user.ts b/server/types/models/user/user.ts
new file mode 100644
index 000000000..7938ea288
--- /dev/null
+++ b/server/types/models/user/user.ts
@@ -0,0 +1,89 @@
+import { UserModel } from '../../../models/account/user'
+import { PickWith, PickWithOpt } from '../../utils'
+import {
+  MAccount,
+  MAccountDefault,
+  MAccountDefaultChannelDefault,
+  MAccountFormattable,
+  MAccountId,
+  MAccountIdActorId,
+  MAccountUrl
+} from '../account'
+import { MNotificationSetting, MNotificationSettingFormattable } from './user-notification-setting'
+import { AccountModel } from '@server/models/account/account'
+import { MChannelFormattable } from '../video/video-channels'
+import { MVideoPlaylist } from '@server/types/models'
+
+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>