From 0283eaac2a8e73006c66df3cf5bb9012e37450e5 Mon Sep 17 00:00:00 2001
From: Chocobozzz <me@florianbigard.com>
Date: Tue, 20 Aug 2019 13:52:49 +0200
Subject: Cleanup model types

---
 server/typings/models/account/account-blocklist.ts | 10 ++-
 server/typings/models/account/account.ts           | 69 ++++++++++------
 server/typings/models/account/actor-follow.ts      | 56 +++++++++----
 server/typings/models/account/actor.ts             | 93 ++++++++++++++--------
 4 files changed, 156 insertions(+), 72 deletions(-)

(limited to 'server/typings/models/account')

diff --git a/server/typings/models/account/account-blocklist.ts b/server/typings/models/account/account-blocklist.ts
index 6d1771de8..d20d97aa8 100644
--- a/server/typings/models/account/account-blocklist.ts
+++ b/server/typings/models/account/account-blocklist.ts
@@ -2,10 +2,16 @@ import { AccountBlocklistModel } from '../../../models/account/account-blocklist
 import { PickWith } from '../../utils'
 import { MAccountDefault } from './account'
 
+type Use<K extends keyof AccountBlocklistModel, M> = PickWith<AccountBlocklistModel, K, M>
+
+// ############################################################################
+
 export type MAccountBlocklist = Omit<AccountBlocklistModel, 'ByAccount' | 'BlockedAccount'>
 
+// ############################################################################
+
 export type MAccountBlocklistId = Pick<AccountBlocklistModel, 'id'>
 
 export type MAccountBlocklistAccounts = MAccountBlocklist &
-  PickWith<AccountBlocklistModel, 'ByAccount', MAccountDefault> &
-  PickWith<AccountBlocklistModel, 'BlockedAccount', MAccountDefault>
+  Use<'ByAccount', MAccountDefault> &
+  Use<'BlockedAccount', MAccountDefault>
diff --git a/server/typings/models/account/account.ts b/server/typings/models/account/account.ts
index f3646d510..9a8784e6b 100644
--- a/server/typings/models/account/account.ts
+++ b/server/typings/models/account/account.ts
@@ -5,7 +5,8 @@ import {
   MActorAPI,
   MActorAudience,
   MActorDefault,
-  MActorDefaultLight, MActorId,
+  MActorDefaultLight,
+  MActorId,
   MActorServer,
   MActorSummary,
   MActorUrl
@@ -14,43 +15,63 @@ import { PickWith } from '../../utils'
 import { MAccountBlocklistId } from './account-blocklist'
 import { MChannelDefault } from '@server/typings/models'
 
-export type MAccountId = Pick<AccountModel, 'id'>
-export type MAccountIdActor = MAccountId &
-  PickWith<AccountModel, 'Actor', MActorAccountChannelId>
-export type MAccountIdActorId = MAccountId &
-  PickWith<AccountModel, 'Actor', MActorId>
+type Use<K extends keyof AccountModel, M> = PickWith<AccountModel, K, M>
+
+// ############################################################################
 
 export type MAccount = Omit<AccountModel, 'Actor' | 'User' | 'Application' | 'VideoChannels' | 'VideoPlaylists' |
   'VideoComments' | 'BlockedAccounts'>
 
+// ############################################################################
+
+// Only some attributes
+export type MAccountId = Pick<MAccount, 'id'>
+export type MAccountUserId = Pick<MAccount, 'userId'>
+
+// Only some Actor attributes
+export type MAccountUrl = Use<'Actor', MActorUrl>
+export type MAccountAudience = Use<'Actor', MActorAudience>
+
+export type MAccountIdActor = MAccountId &
+  Use<'Actor', MActorAccountChannelId>
+
+export type MAccountIdActorId = MAccountId &
+  Use<'Actor', MActorId>
+
+// ############################################################################
+
 // Default scope
 export type MAccountDefault = MAccount &
-  PickWith<AccountModel, 'Actor', MActorDefault>
+  Use<'Actor', MActorDefault>
 
-export type MAccountDefaultChannelDefault = MAccountDefault &
-  PickWith<AccountModel, 'VideoChannels', MChannelDefault[]>
+// Default with default association scopes
+export type MAccountDefaultChannelDefault = MAccount &
+  Use<'Actor', MActorDefault> &
+  Use<'VideoChannels', MChannelDefault[]>
 
+// We don't need some actors attributes
 export type MAccountLight = MAccount &
-  PickWith<AccountModel, 'Actor', MActorDefaultLight>
+  Use<'Actor', MActorDefaultLight>
 
-export type MAccountUserId = Pick<MAccount, 'userId'>
+// ############################################################################
 
+// Full actor
 export type MAccountActor = MAccount &
-  PickWith<AccountModel, 'Actor', MActor>
-export type MAccountServer = MAccountActor &
-  PickWith<AccountModel, 'Actor', MActorServer>
+  Use<'Actor', MActor>
 
-export type MAccountActorDefault = MAccount &
-  PickWith<AccountModel, 'Actor', MActorDefault>
+// Full actor with server
+export type MAccountServer = MAccount &
+  Use<'Actor', MActorServer>
 
-export type MAccountSummary = Pick<MAccount, 'id' | 'name'> &
-  PickWith<AccountModel, 'Actor', MActorSummary>
+// ############################################################################
 
-export type MAccountBlocks = MAccountSummary &
-  PickWith<AccountModel, 'BlockedAccounts', MAccountBlocklistId[]>
+// For API
+
+export type MAccountSummary = Pick<MAccount, 'id' | 'name'> &
+  Use<'Actor', MActorSummary>
 
-export type MAccountAPI = MAccountDefault &
-  PickWith<AccountModel, 'Actor', MActorAPI>
+export type MAccountSummaryBlocks = MAccountSummary &
+  Use<'BlockedAccounts', MAccountBlocklistId[]>
 
-export type MAccountUrl = PickWith<AccountModel, 'Actor', MActorUrl>
-export type MAccountAudience = PickWith<AccountModel, 'Actor', MActorAudience>
+export type MAccountAPI = MAccount &
+  Use<'Actor', MActorAPI>
diff --git a/server/typings/models/account/actor-follow.ts b/server/typings/models/account/actor-follow.ts
index 96c53d857..87050ac63 100644
--- a/server/typings/models/account/actor-follow.ts
+++ b/server/typings/models/account/actor-follow.ts
@@ -1,27 +1,55 @@
 import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
-import { MActor, MActorAccountChannel, MActorChannel, MActorChannelAccount, MActorDefault, MActorHost, MActorUsername } from './actor'
+import {
+  MActor,
+  MActorAccount,
+  MActorAccountChannel,
+  MActorChannel,
+  MActorChannelAccountActor,
+  MActorDefault,
+  MActorHost,
+  MActorUsername
+} from './actor'
 import { PickWith } from '../../utils'
+import { ActorModel } from '@server/models/activitypub/actor'
+
+type Use<K extends keyof ActorFollowModel, M> = PickWith<ActorFollowModel, K, M>
+
+// ############################################################################
 
 export type MActorFollow = Omit<ActorFollowModel, 'ActorFollower' | 'ActorFollowing'>
 
+// ############################################################################
+
+export type MActorFollowFollowingHost = MActorFollow &
+  Use<'ActorFollowing', MActorUsername & MActorHost>
+
+// ############################################################################
+
+// With actors or actors default
+
 export type MActorFollowActors = MActorFollow &
-  PickWith<ActorFollowModel, 'ActorFollower', MActor> &
-  PickWith<ActorFollowModel, 'ActorFollowing', MActor>
+  Use<'ActorFollower', MActor> &
+  Use<'ActorFollowing', MActor>
 
 export type MActorFollowActorsDefault = MActorFollow &
-  PickWith<ActorFollowModel, 'ActorFollower', MActorDefault> &
-  PickWith<ActorFollowModel, 'ActorFollowing', MActorDefault>
-
-export type MActorFollowActorsDefaultSubscription = MActorFollow &
-  PickWith<ActorFollowModel, 'ActorFollower', MActorDefault> &
-  PickWith<ActorFollowModel, 'ActorFollowing', MActorDefault & MActorChannel>
+  Use<'ActorFollower', MActorDefault> &
+  Use<'ActorFollowing', MActorDefault>
 
 export type MActorFollowFull = MActorFollow &
-  PickWith<ActorFollowModel, 'ActorFollower', MActorAccountChannel> &
-  PickWith<ActorFollowModel, 'ActorFollowing', MActorAccountChannel>
+  Use<'ActorFollower', MActorAccountChannel> &
+  Use<'ActorFollowing', MActorAccountChannel>
 
-export type MActorFollowFollowingHost = MActorFollow &
-  PickWith<ActorFollowModel, 'ActorFollowing', MActorUsername & MActorHost>
+// ############################################################################
+
+// For subscriptions
+
+export type MActorFollowActorsDefaultSubscription = MActorFollow &
+  Use<'ActorFollower', MActorDefault> &
+  Use<'ActorFollowing', MActorDefault & MActorChannel>
+
+export type MActorFollowFollowingFullFollowerAccount = MActorFollow &
+  Use<'ActorFollower', MActorAccount> &
+  Use<'ActorFollowing', MActorAccountChannel>
 
 export type MActorFollowSubscriptions = MActorFollow &
-  PickWith<ActorFollowModel, 'ActorFollowing', MActorChannelAccount>
+  Use<'ActorFollowing', MActorChannelAccountActor>
diff --git a/server/typings/models/account/actor.ts b/server/typings/models/account/actor.ts
index f3e752a98..7d99a433b 100644
--- a/server/typings/models/account/actor.ts
+++ b/server/typings/models/account/actor.ts
@@ -1,74 +1,103 @@
 import { ActorModel } from '../../../models/activitypub/actor'
 import { PickWith } from '../../utils'
-import { MAccount, MAccountActorDefault, MAccountId, MAccountIdActor } from './account'
-import { MServerHost, MServerHostBlocks, MServer } from '../server'
+import { MAccount, MAccountDefault, MAccountId, MAccountIdActor } from './account'
+import { MServer, MServerHost, MServerHostBlocks } from '../server'
 import { MAvatar } from './avatar'
-import { MChannel, MChannelAccountActor, MChannelActorAccountDefault, MChannelId, MChannelIdActor } from '../video'
+import { MChannel, MChannelAccountActor, MChannelAccountDefault, MChannelId, MChannelIdActor } from '../video'
+
+type Use<K extends keyof ActorModel, M> = PickWith<ActorModel, K, M>
+
+// ############################################################################
 
 export type MActor = Omit<ActorModel, 'Account' | 'VideoChannel' | 'ActorFollowing' | 'Avatar' | 'ActorFollowers' | 'Server'>
 
+// ############################################################################
+
 export type MActorUrl = Pick<MActor, 'url'>
 export type MActorId = Pick<MActor, 'id'>
 export type MActorUsername = Pick<MActor, 'preferredUsername'>
-export type MActorHost = PickWith<ActorModel, 'Server', MServerHost>
 
 export type MActorFollowersUrl = Pick<MActor, 'followersUrl'>
 export type MActorAudience = MActorUrl & MActorFollowersUrl
+export type MActorFollowerException = Pick<ActorModel, 'sharedInboxUrl' | 'inboxUrl'>
+export type MActorSignature = MActorAccountChannelId
 
 export type MActorLight = Omit<MActor, 'privateKey' | 'privateKey'>
 
+// ############################################################################
+
+// Some association attributes
+
+export type MActorHost = Use<'Server', MServerHost>
+
 export type MActorDefaultLight = MActorLight &
-  MActorHost &
-  PickWith<ActorModel, 'Avatar', MAvatar>
+  Use<'Server', MServerHost> &
+  Use<'Avatar', MAvatar>
 
 export type MActorAccountId = MActor &
-  PickWith<ActorModel, 'Account', MAccountId>
+  Use<'Account', MAccountId>
 export type MActorAccountIdActor = MActor &
-  PickWith<ActorModel, 'Account', MAccountIdActor>
+  Use<'Account', MAccountIdActor>
 
 export type MActorChannelId = MActor &
-  PickWith<ActorModel, 'VideoChannel', MChannelId>
+  Use<'VideoChannel', MChannelId>
 export type MActorChannelIdActor = MActor &
-  PickWith<ActorModel, 'VideoChannel', MChannelIdActor>
+  Use<'VideoChannel', MChannelIdActor>
 
 export type MActorAccountChannelId = MActorAccountId & MActorChannelId
 export type MActorAccountChannelIdActor = MActorAccountIdActor & MActorChannelIdActor
 
+// ############################################################################
+
+// Include raw account/channel/server
+
 export type MActorAccount = MActor &
-  PickWith<ActorModel, 'Account', MAccount>
+  Use<'Account', MAccount>
 
 export type MActorChannel = MActor &
-  PickWith<ActorModel, 'VideoChannel', MChannel>
+  Use<'VideoChannel', MChannel>
 
 export type MActorAccountChannel = MActorAccount & MActorChannel
 
-export type MActorChannelAccount = MActor &
-  PickWith<ActorModel, 'VideoChannel', MChannelAccountActor>
-
 export type MActorServer = MActor &
-  PickWith<ActorModel, 'Server', MServer>
+  Use<'Server', MServer>
 
-export type MActorDefault = MActorServer &
-  PickWith<ActorModel, 'Avatar', MAvatar>
+// ############################################################################
 
-export type MActorFull = MActorDefault &
-  PickWith<ActorModel, 'Account', MAccount> &
-  PickWith<ActorModel, 'VideoChannel', MChannelAccountActor>
+// Complex actor associations
 
-export type MActorFullActor = MActorDefault &
-  PickWith<ActorModel, 'Account', MAccountActorDefault> &
-  PickWith<ActorModel, 'VideoChannel', MChannelActorAccountDefault>
+export type MActorDefault = MActor &
+  Use<'Server', MServer> &
+  Use<'Avatar', MAvatar>
 
-export type MActorSummary = Pick<MActor, 'id' | 'preferredUsername' | 'url' | 'serverId' | 'avatarId'> &
-  MActorHost &
-  PickWith<ActorModel, 'Avatar', MAvatar>
+// Actor with channel that is associated to an account and its actor
+// Actor -> VideoChannel -> Account -> Actor
+export type MActorChannelAccountActor = MActor &
+  Use<'VideoChannel', MChannelAccountActor>
 
-export type MActorSummaryBlocks = Omit<MActorSummary, 'Server'> &
-  PickWith<ActorModel, 'Server', MServerHostBlocks>
+export type MActorFull = MActor &
+  Use<'Server', MServer> &
+  Use<'Avatar', MAvatar> &
+  Use<'Account', MAccount> &
+  Use<'VideoChannel', MChannelAccountActor>
 
-export type MActorFollowerException = Pick<ActorModel, 'sharedInboxUrl' | 'inboxUrl'>
+// Same than ActorFull, but the account and the channel have their actor
+export type MActorFullActor = MActor &
+  Use<'Server', MServer> &
+  Use<'Avatar', MAvatar> &
+  Use<'Account', MAccountDefault> &
+  Use<'VideoChannel', MChannelAccountDefault>
+
+// ############################################################################
+
+// API
+
+export type MActorSummary = Pick<MActor, 'id' | 'preferredUsername' | 'url' | 'serverId' | 'avatarId'> &
+  Use<'Server', MServerHost> &
+  Use<'Avatar', MAvatar>
+
+export type MActorSummaryBlocks = MActorSummary &
+  Use<'Server', MServerHostBlocks>
 
 export type MActorAPI = Omit<MActorDefault, 'publicKey' | 'privateKey' | 'inboxUrl' | 'outboxUrl' | 'sharedInboxUrl' |
   'followersUrl' | 'followingUrl' | 'url' | 'createdAt' | 'updatedAt'>
-
-export type MActorSignature = MActorAccountChannelId
-- 
cgit v1.2.3