server/typings/models/account/account.ts

   1 import { AccountModel } from '../../../models/account/account'
   2 import {
   3   MActor,
   4   MActorAP,
   5   MActorAPI,
   6   MActorAudience,
   7   MActorDefault,
   8   MActorDefaultLight,
   9   MActorFormattable,
  10   MActorId,
  11   MActorServer,
  12   MActorSummary,
  13   MActorSummaryFormattable,
  14   MActorUrl
  15 } from './actor'
  16 import { FunctionProperties, PickWith } from '../../utils'
  17 import { MAccountBlocklistId } from './account-blocklist'
  18 import { MChannelDefault } from '@server/typings/models'
  19
  20 type Use<K extends keyof AccountModel, M> = PickWith<AccountModel, K, M>
  21
  22 // ############################################################################
  23
  24 export type MAccount = Omit<AccountModel, 'Actor' | 'User' | 'Application' | 'VideoChannels' | 'VideoPlaylists' |
  25   'VideoComments' | 'BlockedAccounts'>
  26
  27 // ############################################################################
  28
  29 // Only some attributes
  30 export type MAccountId = Pick<MAccount, 'id'>
  31 export type MAccountUserId = Pick<MAccount, 'userId'>
  32
  33 // Only some Actor attributes
  34 export type MAccountUrl = Use<'Actor', MActorUrl>
  35 export type MAccountAudience = Use<'Actor', MActorAudience>
  36
  37 export type MAccountIdActor = MAccountId &
  38   Use<'Actor', MActor>
  39
  40 export type MAccountIdActorId = MAccountId &
  41   Use<'Actor', MActorId>
  42
  43 // ############################################################################
  44
  45 // Default scope
  46 export type MAccountDefault = MAccount &
  47   Use<'Actor', MActorDefault>
  48
  49 // Default with default association scopes
  50 export type MAccountDefaultChannelDefault = MAccount &
  51   Use<'Actor', MActorDefault> &
  52   Use<'VideoChannels', MChannelDefault[]>
  53
  54 // We don't need some actors attributes
  55 export type MAccountLight = MAccount &
  56   Use<'Actor', MActorDefaultLight>
  57
  58 // ############################################################################
  59
  60 // Full actor
  61 export type MAccountActor = MAccount &
  62   Use<'Actor', MActor>
  63
  64 // Full actor with server
  65 export type MAccountServer = MAccount &
  66   Use<'Actor', MActorServer>
  67
  68 // ############################################################################
  69
  70 // For API
  71
  72 export type MAccountSummary = FunctionProperties<MAccount> &
  73   Pick<MAccount, 'id' | 'name'> &
  74   Use<'Actor', MActorSummary>
  75
  76 export type MAccountSummaryBlocks = MAccountSummary &
  77   Use<'BlockedAccounts', MAccountBlocklistId[]>
  78
  79 export type MAccountAPI = MAccount &
  80   Use<'Actor', MActorAPI>
  81
  82 // ############################################################################
  83
  84 // Format for API or AP object
  85
  86 export type MAccountSummaryFormattable = FunctionProperties<MAccount> &
  87   Pick<MAccount, 'id' | 'name'> &
  88   Use<'Actor', MActorSummaryFormattable>
  89
  90 export type MAccountFormattable = FunctionProperties<MAccount> &
  91   Pick<MAccount, 'id' | 'name' | 'description' | 'createdAt' | 'updatedAt' | 'userId'> &
  92   Use<'Actor', MActorFormattable>
  93
  94 export type MAccountAP = Pick<MAccount, 'name' | 'description'> &
  95   Use<'Actor', MActorAP>