repos

Documentation

Index

• type Activity
• type DemoTwoWorkItem
• type DemoTwoWorkItemCreateParams
• type DemoTwoWorkItemUpdateParams
• type DemoWorkItem
• type DemoWorkItemCreateParams
• type DemoWorkItemUpdateParams
• type KanbanStep
• type Notification
• type Project
• type Team
• type TimeEntry
• type User
• type WorkItem
• type WorkItemComment
• type WorkItemTag
• type WorkItemType

Types

type Activity

type Activity interface {
	ByID(ctx context.Context, d db.DBTX, id db.ActivityID, opts ...db.ActivitySelectConfigOption) (*db.Activity, error)
	ByName(ctx context.Context, d db.DBTX, name string, projectID db.ProjectID, opts ...db.ActivitySelectConfigOption) (*db.Activity, error)
	ByProjectID(ctx context.Context, d db.DBTX, projectID db.ProjectID, opts ...db.ActivitySelectConfigOption) ([]db.Activity, error)
	Create(ctx context.Context, d db.DBTX, params *db.ActivityCreateParams) (*db.Activity, error)
	Update(ctx context.Context, d db.DBTX, id db.ActivityID, params *db.ActivityUpdateParams) (*db.Activity, error)
	Delete(ctx context.Context, d db.DBTX, id db.ActivityID) (*db.Activity, error)
}

Activity defines the datastore/repository handling persisting Activity records.

type DemoTwoWorkItem

type DemoTwoWorkItem interface {
	// ByID returns a generic WorkItem with project-specific fields joined by default.
	ByID(ctx context.Context, d db.DBTX, id db.WorkItemID, opts ...db.WorkItemSelectConfigOption) (*db.WorkItem, error)
	// params for dedicated workItem only require workItemID (FK-as-PK)
	Create(ctx context.Context, d db.DBTX, params DemoTwoWorkItemCreateParams) (*db.WorkItem, error)
	Update(ctx context.Context, d db.DBTX, id db.WorkItemID, params DemoTwoWorkItemUpdateParams) (*db.WorkItem, error)
}

DemoTwoWorkItem defines the datastore/repository handling persisting DemoTwoWorkItem records.

type DemoTwoWorkItemCreateParams

type DemoTwoWorkItemCreateParams struct {
	DemoTwoProject db.DemoTwoWorkItemCreateParams `json:"demoTwoProject" required:"true"`
	Base           db.WorkItemCreateParams        `json:"base"           required:"true"`
}

type DemoTwoWorkItemUpdateParams

type DemoTwoWorkItemUpdateParams struct {
	DemoTwoProject *db.DemoTwoWorkItemUpdateParams `json:"demoTwoProject"`
	Base           *db.WorkItemUpdateParams        `json:"base"`
}

type DemoWorkItem

type DemoWorkItem interface {
	// ByID returns a generic WorkItem with project-specific fields joined by default.
	ByID(ctx context.Context, d db.DBTX, id db.WorkItemID, opts ...db.WorkItemSelectConfigOption) (*db.WorkItem, error)
	// params for dedicated workItem only require workItemID (FK-as-PK)
	Create(ctx context.Context, d db.DBTX, params DemoWorkItemCreateParams) (*db.WorkItem, error)
	Update(ctx context.Context, d db.DBTX, id db.WorkItemID, params DemoWorkItemUpdateParams) (*db.WorkItem, error)
}

DemoWorkItem defines the datastore/repository handling persisting DemoWorkItem records.

type DemoWorkItemCreateParams

type DemoWorkItemCreateParams struct {
	DemoProject db.DemoWorkItemCreateParams `json:"demoProject" required:"true"`
	Base        db.WorkItemCreateParams     `json:"base"        required:"true"`
}

type DemoWorkItemUpdateParams

type DemoWorkItemUpdateParams struct {
	DemoProject *db.DemoWorkItemUpdateParams `json:"demoProject"`
	Base        *db.WorkItemUpdateParams     `json:"base"`
}

type KanbanStep

type KanbanStep interface {
	ByID(ctx context.Context, d db.DBTX, id db.KanbanStepID, opts ...db.KanbanStepSelectConfigOption) (*db.KanbanStep, error)
	ByProject(ctx context.Context, d db.DBTX, projectID db.ProjectID, opts ...db.KanbanStepSelectConfigOption) ([]db.KanbanStep, error)
}

KanbanStep defines the datastore/repository handling persisting KanbanStep records. NOTE: Read-only. Managed via migrations.

type Notification

type Notification interface {
	LatestUserNotifications(ctx context.Context, d db.DBTX, params *db.GetUserNotificationsParams) ([]db.GetUserNotificationsRow, error)
	Create(ctx context.Context, d db.DBTX, params *db.NotificationCreateParams) (*db.Notification, error)
	Delete(ctx context.Context, d db.DBTX, id db.NotificationID) (*db.Notification, error)
}

Notification defines the datastore/repository handling persisting Notification records.

type Project

type Project interface {
	ByName(ctx context.Context, d db.DBTX, name models.Project, opts ...db.ProjectSelectConfigOption) (*db.Project, error)
	ByID(ctx context.Context, d db.DBTX, id db.ProjectID, opts ...db.ProjectSelectConfigOption) (*db.Project, error)
}

Project defines the datastore/repository handling persisting Project records. Projects are manually created on demand. NOTE: Read-only. Managed via migrations.

type Team

type Team interface {
	ByID(ctx context.Context, d db.DBTX, id db.TeamID, opts ...db.TeamSelectConfigOption) (*db.Team, error)
	ByName(ctx context.Context, d db.DBTX, name string, projectID db.ProjectID, opts ...db.TeamSelectConfigOption) (*db.Team, error)
	Create(ctx context.Context, d db.DBTX, params *db.TeamCreateParams) (*db.Team, error)
	Update(ctx context.Context, d db.DBTX, id db.TeamID, params *db.TeamUpdateParams) (*db.Team, error)
	Delete(ctx context.Context, d db.DBTX, id db.TeamID) (*db.Team, error)
}

Team defines the datastore/repository handling persisting Team records.

type TimeEntry

type TimeEntry interface {
	ByID(ctx context.Context, d db.DBTX, id db.TimeEntryID, opts ...db.TimeEntrySelectConfigOption) (*db.TimeEntry, error)
	Create(ctx context.Context, d db.DBTX, params *db.TimeEntryCreateParams) (*db.TimeEntry, error)
	Update(ctx context.Context, d db.DBTX, id db.TimeEntryID, params *db.TimeEntryUpdateParams) (*db.TimeEntry, error)
	Delete(ctx context.Context, d db.DBTX, id db.TimeEntryID) (*db.TimeEntry, error)
}

TimeEntry defines the datastore/repository handling persisting TimeEntry records.

type User

type User interface {
	ByID(ctx context.Context, d db.DBTX, id db.UserID, opts ...db.UserSelectConfigOption) (*db.User, error)
	ByTeam(ctx context.Context, d db.DBTX, teamID db.TeamID) ([]db.User, error)
	ByProject(ctx context.Context, d db.DBTX, projectID db.ProjectID) ([]db.User, error)
	ByEmail(ctx context.Context, d db.DBTX, email string, opts ...db.UserSelectConfigOption) (*db.User, error)
	ByUsername(ctx context.Context, d db.DBTX, username string, opts ...db.UserSelectConfigOption) (*db.User, error)
	ByExternalID(ctx context.Context, d db.DBTX, extID string, opts ...db.UserSelectConfigOption) (*db.User, error)
	ByAPIKey(ctx context.Context, d db.DBTX, apiKey string) (*db.User, error)
	Create(ctx context.Context, d db.DBTX, params *db.UserCreateParams) (*db.User, error)
	Update(ctx context.Context, d db.DBTX, id db.UserID, params *db.UserUpdateParams) (*db.User, error)
	Delete(ctx context.Context, d db.DBTX, id db.UserID) (*db.User, error)
	// CreateAPIKey requires an existing user.
	CreateAPIKey(ctx context.Context, d db.DBTX, user *db.User) (*db.UserAPIKey, error)
	DeleteAPIKey(ctx context.Context, d db.DBTX, apiKey string) (*db.UserAPIKey, error)
}

User defines the datastore/repository handling persisting User records.

type WorkItem

type WorkItem interface {
	// ByID returns a generic WorkItem by default.
	ByID(ctx context.Context, d db.DBTX, id db.WorkItemID, opts ...db.WorkItemSelectConfigOption) (*db.WorkItem, error)
	Delete(ctx context.Context, d db.DBTX, id db.WorkItemID) (*db.WorkItem, error)
	Restore(ctx context.Context, d db.DBTX, id db.WorkItemID) (*db.WorkItem, error)
	AssignUser(ctx context.Context, d db.DBTX, params *db.WorkItemAssignedUserCreateParams) error
	RemoveAssignedUser(ctx context.Context, d db.DBTX, memberID db.UserID, workItemID db.WorkItemID) error
	AssignTag(ctx context.Context, d db.DBTX, params *db.WorkItemWorkItemTagCreateParams) error
	RemoveTag(ctx context.Context, d db.DBTX, tagID db.WorkItemTagID, workItemID db.WorkItemID) error
}

WorkItem defines the datastore/repository handling retrieving WorkItem records.

type WorkItemComment

type WorkItemComment interface {
	ByID(ctx context.Context, d db.DBTX, id db.WorkItemCommentID, opts ...db.WorkItemCommentSelectConfigOption) (*db.WorkItemComment, error)
	Create(ctx context.Context, d db.DBTX, params *db.WorkItemCommentCreateParams) (*db.WorkItemComment, error)
	Update(ctx context.Context, d db.DBTX, id db.WorkItemCommentID, params *db.WorkItemCommentUpdateParams) (*db.WorkItemComment, error)
	Delete(ctx context.Context, d db.DBTX, id db.WorkItemCommentID) (*db.WorkItemComment, error)
}

WorkItemComment defines the datastore/repository handling persisting WorkItemComment records.

type WorkItemTag

type WorkItemTag interface {
	ByID(ctx context.Context, d db.DBTX, id db.WorkItemTagID, opts ...db.WorkItemTagSelectConfigOption) (*db.WorkItemTag, error)
	// TODO ByProjectID(ctx context.Context, d db.DBTX, id db.WorkItemTagID) ([]*db.WorkItemTag, error)
	ByName(ctx context.Context, d db.DBTX, name string, projectID db.ProjectID, opts ...db.WorkItemTagSelectConfigOption) (*db.WorkItemTag, error)
	Create(ctx context.Context, d db.DBTX, params *db.WorkItemTagCreateParams) (*db.WorkItemTag, error)
	Update(ctx context.Context, d db.DBTX, id db.WorkItemTagID, params *db.WorkItemTagUpdateParams) (*db.WorkItemTag, error)
	Delete(ctx context.Context, d db.DBTX, id db.WorkItemTagID) (*db.WorkItemTag, error)
}

WorkItemTag defines the datastore/repository handling persisting WorkItemTag records.

type WorkItemType

type WorkItemType interface {
	ByID(ctx context.Context, d db.DBTX, id db.WorkItemTypeID, opts ...db.WorkItemTypeSelectConfigOption) (*db.WorkItemType, error)
	// TODO ByProjectID(ctx context.Context, d db.DBTX, id int) ([]*db.WorkItemType, error)
	ByName(ctx context.Context, d db.DBTX, name string, projectID db.ProjectID, opts ...db.WorkItemTypeSelectConfigOption) (*db.WorkItemType, error)
}

WorkItemType defines the datastore/repository handling persisting WorkItemType records. NOTE: Read-only. Managed via migrations.