server/models/account/account-interface.ts

   1 import * as Bluebird from 'bluebird'
   2 import * as Sequelize from 'sequelize'
   3 import { Account as FormattedAccount, ActivityPubActor } from '../../../shared'
   4 import { AvatarInstance } from '../avatar'
   5 import { ServerInstance } from '../server/server-interface'
   6 import { VideoChannelInstance } from '../video/video-channel-interface'
   7
   8 export namespace AccountMethods {
   9   export type LoadApplication = () => Bluebird<AccountInstance>
  10
  11   export type Load = (id: number) => Bluebird<AccountInstance>
  12   export type LoadByUUID = (uuid: string) => Bluebird<AccountInstance>
  13   export type LoadByUrl = (url: string, transaction?: Sequelize.Transaction) => Bluebird<AccountInstance>
  14   export type LoadLocalByName = (name: string) => Bluebird<AccountInstance>
  15   export type LoadByNameAndHost = (name: string, host: string) => Bluebird<AccountInstance>
  16   export type ListByFollowersUrls = (followerUrls: string[], transaction: Sequelize.Transaction) => Bluebird<AccountInstance[]>
  17
  18   export type ToActivityPubObject = (this: AccountInstance) => ActivityPubActor
  19   export type ToFormattedJSON = (this: AccountInstance) => FormattedAccount
  20   export type IsOwned = (this: AccountInstance) => boolean
  21   export type GetFollowerSharedInboxUrls = (this: AccountInstance, t: Sequelize.Transaction) => Bluebird<string[]>
  22   export type GetFollowingUrl = (this: AccountInstance) => string
  23   export type GetFollowersUrl = (this: AccountInstance) => string
  24   export type GetPublicKeyUrl = (this: AccountInstance) => string
  25 }
  26
  27 export interface AccountClass {
  28   loadApplication: AccountMethods.LoadApplication
  29   load: AccountMethods.Load
  30   loadByUUID: AccountMethods.LoadByUUID
  31   loadByUrl: AccountMethods.LoadByUrl
  32   loadLocalByName: AccountMethods.LoadLocalByName
  33   loadByNameAndHost: AccountMethods.LoadByNameAndHost
  34   listByFollowersUrls: AccountMethods.ListByFollowersUrls
  35 }
  36
  37 export interface AccountAttributes {
  38   name: string
  39   url?: string
  40   publicKey: string
  41   privateKey: string
  42   followersCount: number
  43   followingCount: number
  44   inboxUrl: string
  45   outboxUrl: string
  46   sharedInboxUrl: string
  47   followersUrl: string
  48   followingUrl: string
  49
  50   uuid?: string
  51
  52   serverId?: number
  53   userId?: number
  54   applicationId?: number
  55   avatarId?: number
  56 }
  57
  58 export interface AccountInstance extends AccountClass, AccountAttributes, Sequelize.Instance<AccountAttributes> {
  59   isOwned: AccountMethods.IsOwned
  60   toActivityPubObject: AccountMethods.ToActivityPubObject
  61   toFormattedJSON: AccountMethods.ToFormattedJSON
  62   getFollowerSharedInboxUrls: AccountMethods.GetFollowerSharedInboxUrls
  63   getFollowingUrl: AccountMethods.GetFollowingUrl
  64   getFollowersUrl: AccountMethods.GetFollowersUrl
  65   getPublicKeyUrl: AccountMethods.GetPublicKeyUrl
  66
  67   id: number
  68   createdAt: Date
  69   updatedAt: Date
  70
  71   Server: ServerInstance
  72   VideoChannels: VideoChannelInstance[]
  73   Avatar: AvatarInstance
  74 }
  75
  76 export interface AccountModel extends AccountClass, Sequelize.Model<AccountInstance, AccountAttributes> {}