Split types and typings

6 files changed, 362 insertions, 0 deletions

diff --git a/server/types/models/account/account-blocklist.ts b/server/types/models/account/account-blocklist.ts
new file mode 100644
index 000000000..0d8bf11bd
--- /dev/null
+++ b/server/types/models/account/account-blocklist.ts
@@ -0,0 +1,27 @@
+import { AccountBlocklistModel } from '../../../models/account/account-blocklist'
+import { PickWith } from '../../utils'
+import { MAccountDefault, MAccountFormattable } 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 &
+  Use<'ByAccount', MAccountDefault> &
+  Use<'BlockedAccount', MAccountDefault>
+
+// ############################################################################
+
+// Format for API or AP object
+
+export type MAccountBlocklistFormattable =
+  Pick<MAccountBlocklist, 'createdAt'> &
+  Use<'ByAccount', MAccountFormattable> &
+  Use<'BlockedAccount', MAccountFormattable>
diff --git a/server/types/models/account/account.ts b/server/types/models/account/account.ts
new file mode 100644
index 000000000..7b826ee04
--- /dev/null
+++ b/server/types/models/account/account.ts
@@ -0,0 +1,109 @@
+import { AccountModel } from '../../../models/account/account'
+import {
+  MActor,
+  MActorAP,
+  MActorAPI,
+  MActorAudience,
+  MActorDefault,
+  MActorDefaultLight,
+  MActorFormattable,
+  MActorId,
+  MActorServer,
+  MActorSummary,
+  MActorSummaryFormattable,
+  MActorUrl
+} from './actor'
+import { FunctionProperties, PickWith } from '../../utils'
+import { MAccountBlocklistId } from './account-blocklist'
+import { MChannelDefault } from '../video/video-channels'
+
+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', MActor>
+
+export type MAccountIdActorId =
+  MAccountId &
+  Use<'Actor', MActorId>
+
+// ############################################################################
+
+// Default scope
+export type MAccountDefault =
+  MAccount &
+  Use<'Actor', MActorDefault>
+
+// 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 &
+  Use<'Actor', MActorDefaultLight>
+
+// ############################################################################
+
+// Full actor
+export type MAccountActor =
+  MAccount &
+  Use<'Actor', MActor>
+
+// Full actor with server
+export type MAccountServer =
+  MAccount &
+  Use<'Actor', MActorServer>
+
+// ############################################################################
+
+// For API
+
+export type MAccountSummary =
+  FunctionProperties<MAccount> &
+  Pick<MAccount, 'id' | 'name'> &
+  Use<'Actor', MActorSummary>
+
+export type MAccountSummaryBlocks =
+  MAccountSummary &
+  Use<'BlockedAccounts', MAccountBlocklistId[]>
+
+export type MAccountAPI =
+  MAccount &
+  Use<'Actor', MActorAPI>
+
+// ############################################################################
+
+// Format for API or AP object
+
+export type MAccountSummaryFormattable =
+  FunctionProperties<MAccount> &
+  Pick<MAccount, 'id' | 'name'> &
+  Use<'Actor', MActorSummaryFormattable>
+
+export type MAccountFormattable =
+  FunctionProperties<MAccount> &
+  Pick<MAccount, 'id' | 'name' | 'description' | 'createdAt' | 'updatedAt' | 'userId'> &
+  Use<'Actor', MActorFormattable>
+
+export type MAccountAP =
+  Pick<MAccount, 'name' | 'description'> &
+  Use<'Actor', MActorAP>
diff --git a/server/types/models/account/actor-follow.ts b/server/types/models/account/actor-follow.ts
new file mode 100644
index 000000000..5d0c03c8d
--- /dev/null
+++ b/server/types/models/account/actor-follow.ts
@@ -0,0 +1,70 @@
+import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
+import {
+  MActor,
+  MActorChannelAccountActor,
+  MActorDefault,
+  MActorDefaultAccountChannel,
+  MActorFormattable,
+  MActorHost,
+  MActorUsername
+} from './actor'
+import { PickWith } from '../../utils'
+import { ActorModel } from '@server/models/activitypub/actor'
+import { MChannelDefault } from '../video/video-channels'
+
+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 &
+  Use<'ActorFollower', MActor> &
+  Use<'ActorFollowing', MActor>
+
+export type MActorFollowActorsDefault =
+  MActorFollow &
+  Use<'ActorFollower', MActorDefault> &
+  Use<'ActorFollowing', MActorDefault>
+
+export type MActorFollowFull =
+  MActorFollow &
+  Use<'ActorFollower', MActorDefaultAccountChannel> &
+  Use<'ActorFollowing', MActorDefaultAccountChannel>
+
+// ############################################################################
+
+// For subscriptions
+
+type SubscriptionFollowing =
+  MActorDefault &
+  PickWith<ActorModel, 'VideoChannel', MChannelDefault>
+
+export type MActorFollowActorsDefaultSubscription =
+  MActorFollow &
+  Use<'ActorFollower', MActorDefault> &
+  Use<'ActorFollowing', SubscriptionFollowing>
+
+export type MActorFollowSubscriptions =
+  MActorFollow &
+  Use<'ActorFollowing', MActorChannelAccountActor>
+
+// ############################################################################
+
+// Format for API or AP object
+
+export type MActorFollowFormattable =
+  Pick<MActorFollow, 'id' | 'score' | 'state' | 'createdAt' | 'updatedAt'> &
+  Use<'ActorFollower', MActorFormattable> &
+  Use<'ActorFollowing', MActorFormattable>
diff --git a/server/types/models/account/actor.ts b/server/types/models/account/actor.ts
new file mode 100644
index 000000000..1160e84cb
--- /dev/null
+++ b/server/types/models/account/actor.ts
@@ -0,0 +1,139 @@
+import { ActorModel } from '../../../models/activitypub/actor'
+import { FunctionProperties, PickWith, PickWithOpt } from '../../utils'
+import { MAccount, MAccountDefault, MAccountId, MAccountIdActor } from './account'
+import { MServer, MServerHost, MServerHostBlocks, MServerRedundancyAllowed } from '../server'
+import { MAvatar, MAvatarFormattable } from './avatar'
+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 MActorFollowersUrl = Pick<MActor, 'followersUrl'>
+export type MActorAudience = MActorUrl & MActorFollowersUrl
+export type MActorWithInboxes = Pick<ActorModel, 'sharedInboxUrl' | 'inboxUrl' | 'getSharedInbox'>
+export type MActorSignature = MActorAccountChannelId
+
+export type MActorLight = Omit<MActor, 'privateKey' | 'privateKey'>
+
+// ############################################################################
+
+// Some association attributes
+
+export type MActorHost = Use<'Server', MServerHost>
+export type MActorRedundancyAllowedOpt = PickWithOpt<ActorModel, 'Server', MServerRedundancyAllowed>
+
+export type MActorDefaultLight =
+  MActorLight &
+  Use<'Server', MServerHost> &
+  Use<'Avatar', MAvatar>
+
+export type MActorAccountId =
+  MActor &
+  Use<'Account', MAccountId>
+export type MActorAccountIdActor =
+  MActor &
+  Use<'Account', MAccountIdActor>
+
+export type MActorChannelId =
+  MActor &
+  Use<'VideoChannel', MChannelId>
+export type MActorChannelIdActor =
+  MActor &
+  Use<'VideoChannel', MChannelIdActor>
+
+export type MActorAccountChannelId = MActorAccountId & MActorChannelId
+export type MActorAccountChannelIdActor = MActorAccountIdActor & MActorChannelIdActor
+
+// ############################################################################
+
+// Include raw account/channel/server
+
+export type MActorAccount =
+  MActor &
+  Use<'Account', MAccount>
+
+export type MActorChannel =
+  MActor &
+  Use<'VideoChannel', MChannel>
+
+export type MActorDefaultAccountChannel = MActorDefault & MActorAccount & MActorChannel
+
+export type MActorServer =
+  MActor &
+  Use<'Server', MServer>
+
+// ############################################################################
+
+// Complex actor associations
+
+export type MActorDefault =
+  MActor &
+  Use<'Server', MServer> &
+  Use<'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 MActorFull =
+  MActor &
+  Use<'Server', MServer> &
+  Use<'Avatar', MAvatar> &
+  Use<'Account', MAccount> &
+  Use<'VideoChannel', MChannelAccountActor>
+
+// 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 =
+  FunctionProperties<MActor> &
+  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'>
+
+// ############################################################################
+
+// Format for API or AP object
+
+export type MActorSummaryFormattable =
+  FunctionProperties<MActor> &
+  Pick<MActor, 'url' | 'preferredUsername'> &
+  Use<'Server', MServerHost> &
+  Use<'Avatar', MAvatarFormattable>
+
+export type MActorFormattable =
+  MActorSummaryFormattable &
+  Pick<MActor, 'id' | 'followingCount' | 'followersCount' | 'createdAt' | 'updatedAt'> &
+  Use<'Server', MServerHost & Partial<Pick<MServer, 'redundancyAllowed'>>>
+
+export type MActorAP =
+  MActor &
+  Use<'Avatar', MAvatar>
diff --git a/server/types/models/account/avatar.ts b/server/types/models/account/avatar.ts
new file mode 100644
index 000000000..6eba59ee4
--- /dev/null
+++ b/server/types/models/account/avatar.ts
@@ -0,0 +1,12 @@
+import { AvatarModel } from '../../../models/avatar/avatar'
+import { FunctionProperties } from '@server/types/utils'
+
+export type MAvatar = AvatarModel
+
+// ############################################################################
+
+// Format for API or AP object
+
+export type MAvatarFormattable =
+  FunctionProperties<MAvatar> &
+  Pick<MAvatar, 'filename' | 'createdAt' | 'updatedAt'>
diff --git a/server/types/models/account/index.ts b/server/types/models/account/index.ts
new file mode 100644
index 000000000..513c09c40
--- /dev/null
+++ b/server/types/models/account/index.ts
@@ -0,0 +1,5 @@
+export * from './account'
+export * from './account-blocklist'
+export * from './actor'
+export * from './actor-follow'
+export * from './avatar'