generated

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 8, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BaseModel added in v0.4.0 

type BaseModel[TID comparable] struct {
	ID TID `gorm:"primaryKey" db:"id"`
}

BaseModel is a convenience embed for domain models used with Repository[T, TID] and Usecase[T, TID]. It provides GetID (value receiver, satisfies Model[TID] constraint) and SetID implementations.

Usage: 

type MyModel struct {
    generated.BaseModel[uint64]
    Name string
}

func (BaseModel[TID]) GetID added in v0.4.0 

func (m BaseModel[TID]) GetID() TID

GetID returns the model's primary key. Value receiver ensures MyModel (not *MyModel) satisfies the Model[TID] constraint.

func (*BaseModel[TID]) SetID added in v0.4.0 

func (m *BaseModel[TID]) SetID(id TID)

SetID sets the model's primary key.

type BaseTimestamps added in v0.4.0 

type BaseTimestamps struct {
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

BaseTimestamps is a convenience embed providing SetCreatedAt and SetUpdatedAt.

Usage: 

type MyModel struct {
    generated.BaseModel[uint64]
    generated.BaseTimestamps
    gorm.DeletedAt
}

func (*BaseTimestamps) SetCreatedAt added in v0.4.0 

func (m *BaseTimestamps) SetCreatedAt(t time.Time)

SetCreatedAt sets the creation timestamp.

func (*BaseTimestamps) SetUpdatedAt added in v0.4.0 

func (m *BaseTimestamps) SetUpdatedAt(t time.Time)

SetUpdatedAt sets the update timestamp.

type Model added in v0.4.0 

type Model[TID comparable] interface {
	GetID() TID
}

Model is the compile-time constraint for types used with Repository[T, TID] and Usecase[T, TID]. T must expose its primary key via a value receiver so that T itself (not *T) satisfies the constraint.

type ModelApproveStatusSetter 

type ModelApproveStatusSetter interface {
	SetApproveStatus(status pkgModels.ApproveStatus)
}

ModelApproveStatusSetter defines an interface for models that support an approval workflow.

type ModelCreateTimeSetter 

type ModelCreateTimeSetter interface {
	SetCreatedAt(time.Time)
}

ModelCreateTimeSetter defines an interface for models that can set their creation time.

type ModelIDFieldGetter 

type ModelIDFieldGetter interface {
	GetIDField() string
}

ModelIDFieldGetter defines an interface for models that can override the primary key column name.

type ModelIDSetter 

type ModelIDSetter[TID any] interface {
	SetID(id TID)
}

ModelIDSetter defines an interface for models that can set their primary key.

type ModelUpdateTimeSetter 

type ModelUpdateTimeSetter interface {
	SetUpdatedAt(time.Time)
}

ModelUpdateTimeSetter defines an interface for models that can set their update time.

type Option 

type Option = repository.QOption

List select options

type Options 

type Options = repository.ListOptions

List select options

type Repository 

type Repository[T Model[TID], TID comparable] struct {
	repository.Repository
	// contains filtered or unexported fields
}

func NewRepository 

func NewRepository[T Model[TID], TID comparable]() *Repository[T, TID]

NewRepository creates a new repository instance

func (*Repository[T, TID]) Count 

func (r *Repository[T, TID]) Count(ctx context.Context, qops ...Option) (count int64, err error)

Count returns the number of campaigns

func (*Repository[T, TID]) Create 

func (r *Repository[T, TID]) Create(ctx context.Context, obj *T, opts ...Option) (TID, error)

Create creates a new campaign

func (*Repository[T, TID]) Delete 

func (r *Repository[T, TID]) Delete(ctx context.Context, id TID, opts ...Option) error

Delete deletes a campaign by ID

func (*Repository[T, TID]) FetchList 

func (r *Repository[T, TID]) FetchList(ctx context.Context, qops ...Option) (list []*T, err error)

FetchList returns a list of campaigns

func (*Repository[T, TID]) Get 

func (r *Repository[T, TID]) Get(ctx context.Context, id TID, qops ...Option) (*T, error)

Get returns a campaign by ID

func (*Repository[T, TID]) Update 

func (r *Repository[T, TID]) Update(ctx context.Context, id TID, obj *T, opts ...Option) error

Update updates an existing campaign

type RepositoryApproveIface 

type RepositoryApproveIface[TID comparable] interface {
	Approve(ctx context.Context, id TID, opts ...Option) error
	Reject(ctx context.Context, id TID, opts ...Option) error
}

type RepositoryApprover 

type RepositoryApprover[T any, TID any] struct {
	repository.Repository
	IDName     string
	StatusName string
}

RepositoryApprover provides methods to approve or reject entities

func (*RepositoryApprover[T, TID]) Approve 

func (r *RepositoryApprover[T, TID]) Approve(ctx context.Context, id TID, message string) error

Approve approves an entity by ID

func (*RepositoryApprover[T, TID]) Reject 

func (r *RepositoryApprover[T, TID]) Reject(ctx context.Context, id TID, message string) error

Reject rejects an entity by ID

type RepositoryIface 

type RepositoryIface[T Model[TID], TID comparable] interface {
	Get(ctx context.Context, id TID, qops ...Option) (*T, error)
	FetchList(ctx context.Context, qops ...Option) ([]*T, error)
	Count(ctx context.Context, qops ...Option) (int64, error)
	Create(ctx context.Context, obj *T, opts ...Option) (TID, error)
	Update(ctx context.Context, id TID, obj *T, opts ...Option) error
	Delete(ctx context.Context, id TID, opts ...Option) error
}

type RepositoryIfaceWithApprove 

type RepositoryIfaceWithApprove[T Model[TID], TID comparable] interface {
	RepositoryIface[T, TID]
	RepositoryApproveIface[TID]
}

type Usecase 

type Usecase[T Model[TID], TID comparable] struct {
	Repo RepositoryIface[T, TID] // Repository interface for data access operations
}

Usecase provides a generic business logic layer with ACL (Access Control List) support for CRUD operations on entities of type T with ID type TID.

func (*Usecase[T, TID]) Count 

func (u *Usecase[T, TID]) Count(ctx context.Context, qops ...Option) (int64, error)

Count returns the total number of entities with ACL permission check. Only counts entities the user has permission to list.

func (*Usecase[T, TID]) Create 

func (u *Usecase[T, TID]) Create(ctx context.Context, obj *T, opts ...Option) (id TID, err error)

Create creates a new entity with ACL permission check. Sets the initial approval status to Pending before delegating to the repository. Returns the ID of the created entity if successful.

func (*Usecase[T, TID]) Delete 

func (u *Usecase[T, TID]) Delete(ctx context.Context, id TID, opts ...Option) error

Delete removes an entity with ACL permission check. Fetches the existing entity first to verify delete permissions.

func (*Usecase[T, TID]) FetchList 

func (u *Usecase[T, TID]) FetchList(ctx context.Context, qops ...Option) ([]*T, error)

FetchList retrieves a list of entities with ACL permission checks. Validates both general list access and individual object access permissions.

func (*Usecase[T, TID]) Get 

func (u *Usecase[T, TID]) Get(ctx context.Context, id TID, qops ...Option) (*T, error)

Get retrieves a single entity by ID with ACL permission check. Returns the entity if found and user has read permissions, otherwise returns an error.

func (*Usecase[T, TID]) Update 

func (u *Usecase[T, TID]) Update(ctx context.Context, id TID, obj *T, opts ...Option) error

Update modifies an existing entity with ACL permission check. Fetches the existing entity first to verify update permissions.

type UsecaseApproveIface 

type UsecaseApproveIface[TID comparable] interface {
	Approve(ctx context.Context, id TID, opts ...Option) error
	Reject(ctx context.Context, id TID, opts ...Option) error
}

type UsecaseApprover 

type UsecaseApprover[T Model[TID], TID comparable] struct {
	Repo RepositoryIfaceWithApprove[T, TID]
}

UsecaseApprover provides approve/reject usecase methods

func (*UsecaseApprover[T, TID]) Approve 

func (u *UsecaseApprover[T, TID]) Approve(ctx context.Context, id TID, opts ...Option) error

Approve approves an entity by ID with ACL permission check

func (*UsecaseApprover[T, TID]) Reject 

func (u *UsecaseApprover[T, TID]) Reject(ctx context.Context, id TID, opts ...Option) error

Reject rejects an entity by ID with ACL permission check

type UsecaseIface 

type UsecaseIface[T Model[TID], TID comparable] interface {
	Get(ctx context.Context, id TID, qops ...Option) (*T, error)
	FetchList(ctx context.Context, qops ...Option) ([]*T, error)
	Count(ctx context.Context, qops ...Option) (int64, error)
	Create(ctx context.Context, obj *T, opts ...Option) (TID, error)
	Update(ctx context.Context, id TID, obj *T, opts ...Option) error
	Delete(ctx context.Context, id TID, opts ...Option) error
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.