beans

type Account struct {
	ID   ID
	Name Name

	BudgetID ID

	// Must be loaded explicitly.
	Balance Amount
}

type AccountContract interface {
	// Creates an account.
	Create(ctx context.Context, auth *BudgetAuthContext, name Name) (*Account, error)

	// Gets all accounts associated with the budget. Loads Balance.
	GetAll(ctx context.Context, auth *BudgetAuthContext) ([]*Account, error)
}

type AccountRepository interface {
	Create(ctx context.Context, id ID, name Name, budgetID ID) error
	Get(ctx context.Context, id ID) (*Account, error)
	// Loads Balance.
	GetForBudget(ctx context.Context, budgetID ID) ([]*Account, error)
}

type Amount struct {
	// contains filtered or unexported fields
}

type AuthContext struct {
	// contains filtered or unexported fields
}

type Budget struct {
	ID   ID
	Name Name

	// Must be explicitly loaded.
	UserIDs []ID
}

type BudgetAuthContext struct {
	*AuthContext
	// contains filtered or unexported fields
}

type BudgetContract interface {
	// Creates a budget.
	Create(ctx context.Context, auth *AuthContext, name Name) (*Budget, error)

	// Gets a budget by the budget ID.
	// Ensures the user has access to the budget.
	Get(ctx context.Context, auth *AuthContext, id ID) (*Budget, error)

	// Gets all budgets accessible to the user.
	GetAll(ctx context.Context, auth *AuthContext) ([]*Budget, error)
}

type BudgetRepository interface {
	// Creates a budget and assigns user to the budget.
	Create(ctx context.Context, tx Tx, id ID, name Name, userID ID) error
	// Gets budget by ID. Attaches UserIDs field.
	Get(ctx context.Context, id ID) (*Budget, error)
	GetBudgetsForUser(ctx context.Context, userID ID) ([]*Budget, error)
}

type Category struct {
	ID       ID
	BudgetID ID
	GroupID  ID
	Name     Name
}

type CategoryContract interface {
	// Creates a category.
	CreateCategory(ctx context.Context, auth *BudgetAuthContext, groupID ID, name Name) (*Category, error)

	// Creates a category group.
	CreateGroup(ctx context.Context, auth *BudgetAuthContext, name Name) (*CategoryGroup, error)

	// Gets all categories and groups for a budget.
	GetAll(ctx context.Context, auth *BudgetAuthContext) ([]*CategoryGroup, []*Category, error)
}

type CategoryGroup struct {
	ID       ID
	BudgetID ID
	Name     Name
	IsIncome bool
}

type CategoryRepository interface {
	Create(ctx context.Context, tx Tx, category *Category) error
	GetSingleForBudget(ctx context.Context, id ID, budgetID ID) (*Category, error)
	GetForBudget(ctx context.Context, budgetID ID) ([]*Category, error)
	CreateGroup(ctx context.Context, tx Tx, categoryGroup *CategoryGroup) error
	GetGroupsForBudget(ctx context.Context, budgetID ID) ([]*CategoryGroup, error)
	GroupExists(ctx context.Context, budgetID ID, id ID) (bool, error)
}

type Countable interface {
	Length() int
}

type Date struct {
	time.Time
	// contains filtered or unexported fields
}

type Emptiable interface {
	Empty() bool
}

type Error interface {
	error
	BeansError() (string, string)
}

type ID ksuid.KSUID

type Month struct {
	ID        ID
	BudgetID  ID
	Date      MonthDate
	Carryover Amount

	// Must be explicitly loaded.
	CarriedOver Amount
	// Must be explicitly loaded.
	Income Amount
	// Must be explicitly loaded.
	Assigned Amount
}

type MonthCategory struct {
	ID         ID
	MonthID    ID
	CategoryID ID
	Amount     Amount

	// Must be explicitly loaded.
	Activity Amount
	// Must be explicitly loaded.
	Available Amount
}

type MonthCategoryRepository interface {
	Create(ctx context.Context, tx Tx, monthCategory *MonthCategory) error
	UpdateAmount(ctx context.Context, monthCategoryID ID, amount Amount) error
	// Gets categories by month. Attaches Activity, Available fields.
	GetForMonth(ctx context.Context, month *Month) ([]*MonthCategory, error)
	// Gets the month category, or creates it if it does not exist.
	GetOrCreate(ctx context.Context, tx Tx, monthID ID, categoryID ID) (*MonthCategory, error)

	// Gets the amount assigned in a month.
	GetAssignedInMonth(ctx context.Context, monthID ID) (Amount, error)
}

type MonthContract interface {
	// Gets a month, its categories, and budgetable amount.
	// If the month does not exist it is created.
	//
	// Attaches the fields: CarriedOver, Income, Assigned.
	GetOrCreate(ctx context.Context, auth *BudgetAuthContext, date MonthDate) (*Month, []*MonthCategory, Amount, error)

	// Updates the given month.
	Update(ctx context.Context, auth *BudgetAuthContext, monthID ID, carryover Amount) error

	// Sets the assigned amount on a category for a month.
	SetCategoryAmount(ctx context.Context, auth *BudgetAuthContext, monthID ID, categoryID ID, amount Amount) error
}

type MonthDate struct {
	// contains filtered or unexported fields
}

type MonthRepository interface {
	Create(ctx context.Context, tx Tx, month *Month) error
	Get(ctx context.Context, id ID) (*Month, error)
	// Only updates the Carryover field.
	Update(ctx context.Context, month *Month) error
	GetOrCreate(ctx context.Context, tx Tx, budgetID ID, date MonthDate) (*Month, error)
	GetForBudget(ctx context.Context, budgetID ID) ([]*Month, error)
}

type Name ValidatableString

type NullString struct {
	// contains filtered or unexported fields
}

type Password string

type PasswordHash string

type Payee struct {
	ID       ID
	BudgetID ID
	Name     Name
}

type PayeeContract interface {
	// Creates a payee.
	CreatePayee(ctx context.Context, auth *BudgetAuthContext, name Name) (*Payee, error)

	// Gets all payees for a budget.
	GetAll(ctx context.Context, auth *BudgetAuthContext) ([]*Payee, error)
}

type PayeeRepository interface {
	Create(ctx context.Context, payee *Payee) error
	Get(ctx context.Context, id ID) (*Payee, error)
	GetForBudget(ctx context.Context, budgetID ID) ([]*Payee, error)
}

type Session struct {
	ID        SessionID
	UserID    ID
	CreatedAt time.Time
}

type SessionID string

type SessionRepository interface {
	Create(userID ID) (*Session, error)
	Get(id SessionID) (*Session, error)
	Delete(id SessionID) error
}

type Transaction struct {
	ID ID

	AccountID  ID
	CategoryID ID
	PayeeID    ID

	Amount Amount
	Date   Date
	Notes  TransactionNotes

	// Must be explicitly loaded.
	Account *Account
	// Must be explicitly loaded.
	CategoryName NullString
	// Must be explicitly loaded.
	PayeeName NullString
}

type TransactionContract interface {
	// Creates a transaction. Attaches Account field.
	Create(ctx context.Context, auth *BudgetAuthContext, params TransactionCreateParams) (*Transaction, error)

	// Gets all transactions for budget. Attaches Account, CategoryName, PayeeName fields.
	GetAll(ctx context.Context, auth *BudgetAuthContext) ([]*Transaction, error)

	// Edits a transaction.
	Update(ctx context.Context, auth *BudgetAuthContext, params TransactionUpdateParams) error
}

type TransactionCreateParams struct {
	TransactionParams
}

type TransactionNotes struct{ NullString }

type TransactionParams struct {
	AccountID  ID
	CategoryID ID
	PayeeID    ID
	Amount     Amount
	Date       Date
	Notes      TransactionNotes
}

type TransactionRepository interface {
	Create(ctx context.Context, transaction *Transaction) error

	Update(ctx context.Context, transaction *Transaction) error

	// Attaches Account, CategoryName, PayeeName fields to Transactions.
	GetForBudget(ctx context.Context, budgetID ID) ([]*Transaction, error)

	// Get transaction. Attaches Account field to Transaction.
	Get(ctx context.Context, id ID) (*Transaction, error)

	// Gets sum of all income transactions between the dates.
	GetIncomeBetween(ctx context.Context, budgetID ID, begin Date, end Date) (Amount, error)
}

type TransactionUpdateParams struct {
	ID ID
	TransactionParams
}

type Tx interface {
	Commit(ctx context.Context) error
	Rollback(ctx context.Context) error
}

type TxManager interface {
	Create(ctx context.Context) (Tx, error)
}

type User struct {
	ID           ID
	Username     Username
	PasswordHash PasswordHash
}

type UserContract interface {
	// Creates a new account
	Register(ctx context.Context, username Username, password Password) error

	// Logs in and returns a session
	Login(ctx context.Context, username Username, password Password) (*Session, error)

	// Logs out and deletes the active session
	Logout(ctx context.Context, auth *AuthContext) error

	// Gets the currently authenticated user
	GetMe(ctx context.Context, auth *AuthContext) (*User, error)
}

type UserRepository interface {
	Create(ctx context.Context, id ID, username Username, passwordHash PasswordHash) error
	Exists(ctx context.Context, username Username) (bool, error)
	Get(ctx context.Context, id ID) (*User, error)
	GetByUsername(ctx context.Context, username Username) (*User, error)
}

type Username string

type Validatable interface {
	Validate() error
}

type ValidatableString string