add transaction template

2024-07-29 00:53:19 +08:00
parent 4c69243bef
commit de086aa29e
25 changed files with 2109 additions and 44 deletions
@@ -0,0 +1,159 @@
+package models
+
+import (
+	"strings"
+
+	"github.com/mayswind/ezbookkeeping/pkg/utils"
+)
+
+// TransactionTemplateType represents transaction template type in database
+type TransactionTemplateType byte
+
+// Transaction template types
+const (
+	TRANSACTION_TEMPLATE_TYPE_NORMAL TransactionTemplateType = 1
+)
+
+// TransactionTemplate represents transaction template stored in database
+type TransactionTemplate struct {
+	TemplateId           int64                   `xorm:"PK"`
+	Uid                  int64                   `xorm:"INDEX(IDX_transaction_uid_deleted_template_type_order) NOT NULL"`
+	Deleted              bool                    `xorm:"INDEX(IDX_transaction_uid_deleted_template_type_order) NOT NULL"`
+	TemplateType         TransactionTemplateType `xorm:"INDEX(IDX_transaction_uid_deleted_template_type_order) NOT NULL"`
+	Name                 string                  `xorm:"VARCHAR(32) NOT NULL"`
+	Type                 TransactionType         `xorm:"NOT NULL"`
+	CategoryId           int64                   `xorm:"NOT NULL"`
+	AccountId            int64                   `xorm:"NOT NULL"`
+	TagIds               string                  `xorm:"VARCHAR(255) NOT NULL"`
+	Amount               int64                   `xorm:"NOT NULL"`
+	RelatedAccountId     int64                   `xorm:"NOT NULL"`
+	RelatedAccountAmount int64                   `xorm:"NOT NULL"`
+	Comment              string                  `xorm:"VARCHAR(255) NOT NULL"`
+	DisplayOrder         int32                   `xorm:"INDEX(IDX_transaction_uid_deleted_template_type_order) NOT NULL"`
+	Hidden               bool                    `xorm:"NOT NULL"`
+	CreatedUnixTime      int64
+	UpdatedUnixTime      int64
+	DeletedUnixTime      int64
+}
+
+// TransactionTemplateListRequest represents all parameters of transaction template list request
+type TransactionTemplateListRequest struct {
+	TemplateType TransactionTemplateType `form:"templateType" binding:"required,min=1,max=1"`
+}
+
+// TransactionTemplateGetRequest represents all parameters of transaction template getting request
+type TransactionTemplateGetRequest struct {
+	Id int64 `form:"id,string" binding:"required,min=1"`
+}
+
+// TransactionTemplateCreateRequest represents all parameters of transaction template creation request
+type TransactionTemplateCreateRequest struct {
+	TemplateType    TransactionTemplateType `json:"templateType" binding:"required,min=1,max=1"`
+	Name            string                  `json:"name" binding:"required,notBlank,max=32"`
+	ClientSessionId string                  `json:"clientSessionId"`
+}
+
+// TransactionTemplateModifyNameRequest represents all parameters of transaction template name modification request
+type TransactionTemplateModifyNameRequest struct {
+	Id   int64  `json:"id,string" binding:"required,min=1"`
+	Name string `json:"name" binding:"required,notBlank,max=32"`
+}
+
+// TransactionTemplateModifyRequest represents all parameters of transaction template modification request
+type TransactionTemplateModifyRequest struct {
+	Id                   int64           `json:"id,string" binding:"required,min=1"`
+	Type                 TransactionType `json:"type" binding:"required"`
+	CategoryId           int64           `json:"categoryId,string"`
+	SourceAccountId      int64           `json:"sourceAccountId,string" binding:"required,min=1"`
+	DestinationAccountId int64           `json:"destinationAccountId,string" binding:"min=0"`
+	SourceAmount         int64           `json:"sourceAmount" binding:"min=-99999999999,max=99999999999"`
+	DestinationAmount    int64           `json:"destinationAmount" binding:"min=-99999999999,max=99999999999"`
+	TagIds               []string        `json:"tagIds"`
+	Comment              string          `json:"comment" binding:"max=255"`
+}
+
+// TransactionTemplateHideRequest represents all parameters of transaction template hiding request
+type TransactionTemplateHideRequest struct {
+	Id     int64 `json:"id,string" binding:"required,min=1"`
+	Hidden bool  `json:"hidden"`
+}
+
+// TransactionTemplateMoveRequest represents all parameters of transaction template moving request
+type TransactionTemplateMoveRequest struct {
+	NewDisplayOrders []*TransactionTemplateNewDisplayOrderRequest `json:"newDisplayOrders"`
+}
+
+// TransactionTemplateNewDisplayOrderRequest represents a data pair of id and display order
+type TransactionTemplateNewDisplayOrderRequest struct {
+	Id           int64 `json:"id,string" binding:"required,min=1"`
+	DisplayOrder int32 `json:"displayOrder"`
+}
+
+// TransactionTemplateDeleteRequest represents all parameters of transaction template deleting request
+type TransactionTemplateDeleteRequest struct {
+	Id int64 `json:"id,string" binding:"required,min=1"`
+}
+
+type TransactionTemplateInfoResponse struct {
+	*TransactionInfoResponse
+	TemplateType TransactionTemplateType `json:"templateType"`
+	Name         string                  `json:"name"`
+	DisplayOrder int32                   `json:"displayOrder"`
+	Hidden       bool                    `json:"hidden"`
+}
+
+// ToTransactionInfoResponse returns a view-object according to database model
+func (t *TransactionTemplate) ToTransactionInfoResponse(utcOffset int16) *TransactionInfoResponse {
+	tagIds := make([]string, 0, 0)
+
+	if t.TagIds != "" {
+		tagIds = strings.Split(t.TagIds, ",")
+	}
+
+	return &TransactionInfoResponse{
+		Id:                   t.TemplateId,
+		TimeSequenceId:       utils.GetMinTransactionTimeFromUnixTime(t.CreatedUnixTime),
+		Type:                 t.Type,
+		CategoryId:           t.CategoryId,
+		Time:                 0,
+		UtcOffset:            utcOffset,
+		SourceAccountId:      t.AccountId,
+		DestinationAccountId: t.RelatedAccountId,
+		SourceAmount:         t.Amount,
+		DestinationAmount:    t.RelatedAccountAmount,
+		HideAmount:           false,
+		TagIds:               tagIds,
+		Comment:              t.Comment,
+		GeoLocation:          nil,
+		Editable:             true,
+	}
+}
+
+// ToTransactionTemplateInfoResponse returns a view-object according to database model
+func (t *TransactionTemplate) ToTransactionTemplateInfoResponse(utcOffset int16) *TransactionTemplateInfoResponse {
+	return &TransactionTemplateInfoResponse{
+		TransactionInfoResponse: t.ToTransactionInfoResponse(utcOffset),
+		TemplateType:            t.TemplateType,
+		Name:                    t.Name,
+		DisplayOrder:            t.DisplayOrder,
+		Hidden:                  t.Hidden,
+	}
+}
+
+// TransactionTemplateInfoResponseSlice represents the slice data structure of TransactionTemplateInfoResponse
+type TransactionTemplateInfoResponseSlice []*TransactionTemplateInfoResponse
+
+// Len returns the count of items
+func (s TransactionTemplateInfoResponseSlice) Len() int {
+	return len(s)
+}
+
+// Swap swaps two items
+func (s TransactionTemplateInfoResponseSlice) Swap(i, j int) {
+	s[i], s[j] = s[j], s[i]
+}
+
+// Less reports whether the first item is less than the second one
+func (s TransactionTemplateInfoResponseSlice) Less(i, j int) bool {
+	return s[i].DisplayOrder < s[j].DisplayOrder
+}