Stronger model typings

5 files changed, 112 insertions, 0 deletions

diff --git a/server/typings/models/user/index.d.ts b/server/typings/models/user/index.d.ts
new file mode 100644
index 000000000..e3353d0b1
--- /dev/null
+++ b/server/typings/models/user/index.d.ts
@@ -0,0 +1,3 @@
+export * from './user'
+export * from './user-notification'
+export * from './user-video-history'
diff --git a/server/typings/models/user/user-notification-setting.ts b/server/typings/models/user/user-notification-setting.ts
new file mode 100644
index 000000000..585d30a66
--- /dev/null
+++ b/server/typings/models/user/user-notification-setting.ts
@@ -0,0 +1,3 @@
+import { UserNotificationSettingModel } from '@server/models/account/user-notification-setting'
+
+export type MNotificationSetting = Omit<UserNotificationSettingModel, 'User'>
diff --git a/server/typings/models/user/user-notification.ts b/server/typings/models/user/user-notification.ts
new file mode 100644
index 000000000..b872c5dc5
--- /dev/null
+++ b/server/typings/models/user/user-notification.ts
@@ -0,0 +1,69 @@
+import { UserNotificationModel } from '../../../models/account/user-notification'
+import { PickWith } 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'
+
+export namespace 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, 'Avatar', Pick<AvatarModel, 'filename' | 'getStaticPath'>> &
+    PickWith<ActorModel, 'Server', Pick<ServerModel, 'host'>>
+
+  export type ActorFollowing = Pick<ActorModel, 'preferredUsername'> &
+    PickWith<ActorModel, 'VideoChannel', VideoChannelInclude> &
+    PickWith<ActorModel, 'Account', AccountInclude>
+
+  export type ActorFollowInclude = Pick<ActorFollowModel, 'id' | 'state'> &
+    PickWith<ActorFollowModel, 'ActorFollower', ActorFollower> &
+    PickWith<ActorFollowModel, 'ActorFollowing', ActorFollowing>
+}
+
+export type UserNotificationModelOnly = Omit<UserNotificationModel, 'User' | 'Video' | 'Comment' | 'VideoAbuse' | 'VideoBlacklist' |
+  'VideoImport' | 'Account' | 'ActorFollow'>
+
+export type UserNotificationModelForApi = UserNotificationModelOnly &
+  PickWith<UserNotificationModel, 'Video', UserNotificationIncludes.VideoIncludeChannel> &
+  PickWith<UserNotificationModel, 'Comment', UserNotificationIncludes.VideoCommentInclude> &
+  PickWith<UserNotificationModel, 'VideoAbuse', UserNotificationIncludes.VideoAbuseInclude> &
+  PickWith<UserNotificationModel, 'VideoBlacklist', UserNotificationIncludes.VideoBlacklistInclude> &
+  PickWith<UserNotificationModel, 'VideoImport', UserNotificationIncludes.VideoImportInclude> &
+  PickWith<UserNotificationModel, 'ActorFollow', UserNotificationIncludes.ActorFollowInclude> &
+  PickWith<UserNotificationModel, 'Account', UserNotificationIncludes.AccountIncludeActor>
diff --git a/server/typings/models/user/user-video-history.ts b/server/typings/models/user/user-video-history.ts
new file mode 100644
index 000000000..62673ab1b
--- /dev/null
+++ b/server/typings/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/typings/models/user/user.ts b/server/typings/models/user/user.ts
new file mode 100644
index 000000000..b91eed8d9
--- /dev/null
+++ b/server/typings/models/user/user.ts
@@ -0,0 +1,32 @@
+import { UserModel } from '../../../models/account/user'
+import { PickWith } from '../../utils'
+import { MAccount, MAccountDefault, MAccountDefaultChannelDefault, MAccountId, MAccountIdActorId, MAccountUrl } from '../account'
+import { MNotificationSetting } from './user-notification-setting'
+
+export type MUser = Omit<UserModel, 'Account' | 'NotificationSetting' | 'VideoImports' | 'OAuthTokens'>
+
+export type MUserId = Pick<UserModel, 'id'>
+
+export type MUserWithNotificationSetting = MUser &
+  PickWith<UserModel, 'NotificationSetting', MNotificationSetting>
+
+export type MUserAccountDefault = MUser &
+  PickWith<UserModel, 'Account', MAccountDefault>
+
+export type MUserAccount = MUser &
+  PickWith<UserModel, 'Account', MAccount>
+
+export type MUserAccountId = MUser &
+  PickWith<UserModel, 'Account', MAccountId>
+
+export type MUserNotifSettingAccount = MUserWithNotificationSetting & MUserAccount
+
+export type MUserDefault = MUser &
+  MUserWithNotificationSetting &
+  MUserAccountDefault
+
+export type MUserChannel = MUserWithNotificationSetting &
+  PickWith<UserModel, 'Account', MAccountDefaultChannelDefault>
+
+export type MUserAccountUrl = MUser &
+  PickWith<UserModel, 'Account', MAccountUrl & MAccountIdActorId>