core

type Chat struct {
	// Unique ID of chat
	ID ChatID

	// Unique ID of chat in Telegram
	TelegramID int64

	// Title of chat.
	Title string

	// Type represents type of chat.
	Type ChatType

	// OwnerID represents user who link the chat.
	OwnerID UserID

	// LinkedAt time when chat was linked to Share File Bot.
	LinkedAt time.Time

	// UpdatedAt time when chat was last updated in Share File Bot.
	UpdatedAt null.Time
}

type ChatDownloadStats struct {
	// Downloads with subscription
	WithSubscription int

	// Downloads with new subscription
	NewSubscription int
}

type ChatID int

type ChatStore interface {
	// Add chat to store.
	Add(ctx context.Context, chat *Chat) error

	// Update chat in store.
	Update(ctx context.Context, chat *Chat) error

	Query() ChatStoreQuery
}

type ChatStoreQuery interface {
	// Filter Users by ID's
	ID(ids ...ChatID) ChatStoreQuery

	TelegramID(v int64) ChatStoreQuery

	// UserID filter response by user id
	OwnerID(id UserID) ChatStoreQuery

	// Query only one item from store.
	One(ctx context.Context) (*Chat, error)

	// Query all items from store.
	All(ctx context.Context) ([]*Chat, error)

	// Delete all matched objects
	Delete(ctx context.Context) (int, error)

	// Count items in store.
	Count(ctx context.Context) (int, error)
}

type ChatType int8

type Download struct {
	// ID of download.
	ID DownloadID

	// Reference to file. Can be null.
	FileID FileID

	// References to user. Can be null.
	UserID UserID

	// If true, means user was requested to subscription and successefuly subscribed,
	// False means, user was already subscribed,
	// Null means check is disable.
	NewSubscription null.Bool

	// At time when download was happen
	At time.Time
}

type DownloadID int

type DownloadRestrictions struct {
	// Request subscription to this chat. Zero means null.
	ChatID ChatID
}

type DownloadStore interface {
	Add(ctx context.Context, download *Download) error
	GetFileStats(ctx context.Context, id FileID) (*FileDownloadStats, error)
	GetChatStats(ctx context.Context, id ChatID) (*ChatDownloadStats, error)
	Query() DownloadStoreQuery
}

type DownloadStoreQuery interface {
	FileID(id FileID) DownloadStoreQuery

	Count(ctx context.Context) (int, error)
}

type File struct {
	// Unique ID of File.
	ID FileID

	// Telegram File ID
	TelegramID string

	// Public File ID
	PublicID string

	// If true, file violates copyright and is not available
	IsViolatesCopyright null.Bool

	// Caption of file
	Caption null.String

	// Kind of file
	Kind Kind

	// MIMEType of file
	MIMEType null.String

	// File name
	Name string

	// File size in bytes
	Size int

	// Contains restrictions for download
	Restriction DownloadRestrictions

	// Metadata contains metadata of file depends by kind.
	Metadata Metadata

	// It's URI of post with tg:// scheme.
	LinkedPostURI null.String

	// Reference to user who uploads file.
	OwnerID UserID

	// Time when file was created.
	CreatedAt time.Time
}

type FileDownloadStats struct {
	// Total downloads count
	Total int

	// Unique downloads count
	Unique int

	// Downloads with subscription
	WithSubscription int

	// Downloads with new subscription
	NewSubscription int
}

type FileID int

type FileStore interface {
	// Add File to store. Update ID.
	Add(ctx context.Context, file *File) error

	// Update file in store.
	Update(ctx context.Context, file *File) error

	Query() FileStoreQuery
}

type FileStoreQuery interface {
	ID(id FileID) FileStoreQuery
	OwnerID(id UserID) FileStoreQuery
	PublicID(ids ...string) FileStoreQuery
	RestrictionChatID(id ChatID) FileStoreQuery

	All(ctx context.Context) ([]*File, error)
	One(ctx context.Context) (*File, error)
	Delete(ctx context.Context) error
	Count(ctx context.Context) (int, error)
}

type Kind int8

type Metadata struct {
	Audio  *MetadataAudio   `json:"audio,omitempty"`
	Stcker *MetadataSticker `json:"stcker,omitempty"`
}

type MetadataAudio struct {
	Title     string `json:"title,omitempty"`
	Performer string `json:"performer,omitempty"`
}

type MetadataSticker struct {
	SetName string `json:"set_name,omitempty"`
	Emoji   string `json:"emoji,omitempty"`
}

type User struct {
	// Unique ID of user in bot and Telegram.
	ID UserID

	// First name of user from Telegram
	FirstName string

	// Last name of user from Telegram (optional)
	LastName null.String

	// Username of user from Telegram (optional)
	Username null.String

	// Language code of user from Telegram (optional)
	LanguageCode string

	// True, if user is admin of bot.
	IsAdmin bool

	// Settings of user
	Settings UserSettings

	// Ref is set we user /start with deep-link like ref_*
	Ref null.String

	// Time of first interaction with bot
	JoinedAt time.Time

	// Time when user info was updated
	UpdatedAt null.Time
}

type UserID int

type UserRefStats []UserRefStatsItem

type UserRefStatsItem struct {
	Ref   null.String
	Count int
}

type UserSettings struct {
	// If true, bot generate super long id's for user files.
	LongIDs bool `json:"long_ids"`

	// Timestamp of last update of user settings.
	UpdatedAt null.Time `json:"updated_at"`
}

type UserStore interface {
	Add(ctx context.Context, user *User) error
	Find(ctx context.Context, id UserID) (*User, error)
	Update(ctx context.Context, user *User) error

	RefStats(ctx context.Context) (UserRefStats, error)

	Query() UserStoreQuery
}

type UserStoreQuery interface {
	Count(ctx context.Context) (int, error)
}