PeerTube/server/models/account/account-interface.ts

75 lines
2.9 KiB
TypeScript

import * as Sequelize from 'sequelize'
import * as Bluebird from 'bluebird'
import { PodInstance } from '../pod/pod-interface'
import { VideoChannelInstance } from '../video/video-channel-interface'
import { ActivityPubActor } from '../../../shared'
import { ResultList } from '../../../shared/models/result-list.model'
export namespace AccountMethods {
export type Load = (id: number) => Bluebird<AccountInstance>
export type LoadByUUID = (uuid: string) => Bluebird<AccountInstance>
export type LoadByUrl = (url: string) => Bluebird<AccountInstance>
export type LoadAccountByPodAndUUID = (uuid: string, podId: number, transaction: Sequelize.Transaction) => Bluebird<AccountInstance>
export type LoadLocalAccountByName = (name: string) => Bluebird<AccountInstance>
export type ListOwned = () => Bluebird<AccountInstance[]>
export type ListFollowerUrlsForApi = (name: string, start: number, count: number) => Promise< ResultList<string> >
export type ListFollowingUrlsForApi = (name: string, start: number, count: number) => Promise< ResultList<string> >
export type ToActivityPubObject = (this: AccountInstance) => ActivityPubActor
export type IsOwned = (this: AccountInstance) => boolean
export type GetFollowerSharedInboxUrls = (this: AccountInstance) => Bluebird<string[]>
export type GetFollowingUrl = (this: AccountInstance) => string
export type GetFollowersUrl = (this: AccountInstance) => string
export type GetPublicKeyUrl = (this: AccountInstance) => string
}
export interface AccountClass {
loadAccountByPodAndUUID: AccountMethods.LoadAccountByPodAndUUID
load: AccountMethods.Load
loadByUUID: AccountMethods.LoadByUUID
loadByUrl: AccountMethods.LoadByUrl
loadLocalAccountByName: AccountMethods.LoadLocalAccountByName
listOwned: AccountMethods.ListOwned
listFollowerUrlsForApi: AccountMethods.ListFollowerUrlsForApi
listFollowingUrlsForApi: AccountMethods.ListFollowingUrlsForApi
}
export interface AccountAttributes {
name: string
url: string
publicKey: string
privateKey: string
followersCount: number
followingCount: number
inboxUrl: string
outboxUrl: string
sharedInboxUrl: string
followersUrl: string
followingUrl: string
uuid?: string
podId?: number
userId?: number
applicationId?: number
}
export interface AccountInstance extends AccountClass, AccountAttributes, Sequelize.Instance<AccountAttributes> {
isOwned: AccountMethods.IsOwned
toActivityPubObject: AccountMethods.ToActivityPubObject
getFollowerSharedInboxUrls: AccountMethods.GetFollowerSharedInboxUrls
getFollowingUrl: AccountMethods.GetFollowingUrl
getFollowersUrl: AccountMethods.GetFollowersUrl
getPublicKeyUrl: AccountMethods.GetPublicKeyUrl
id: number
createdAt: Date
updatedAt: Date
Pod: PodInstance
VideoChannels: VideoChannelInstance[]
}
export interface AccountModel extends AccountClass, Sequelize.Model<AccountInstance, AccountAttributes> {}