ports

Documentation

Index

• type Datastore
• type Handlers
• type Migration
• type ReadTx
• type ReadWriteTx

Types

type Datastore

type Datastore interface {
	// ReadTx starts a read only transaction.
	ReadTx(context.Context, func(context.Context, ReadTx) error) error
	// ReadWriteTx starts a read write transaction.
	ReadWriteTx(context.Context, func(context.Context, ReadWriteTx) error) error

	io.Closer
	Migration
}

Datastore provides methods for transactional operations.

type Handlers

type Handlers interface {
	// Login ...
	Login() fiber.Handler
	// Dashboard ...
	Dashboard() fiber.Handler
	// Me ...
	Me() fiber.Handler
	// ListDesigns ...
	ListDesigns() fiber.Handler
	// NewDesign ...
	NewDesign() fiber.Handler
	// ShowDesign ...
	ShowDesign() fiber.Handler
	// CreateDesign ...
	CreateDesign() fiber.Handler
	// CreateDesignComment ...
	CreateDesignComment() fiber.Handler
	// UpdateDesign ...
	UpdateDesign() fiber.Handler
	// DeleteDesign ...
	DeleteDesign() fiber.Handler
	// ListProfiles ...
	ListProfiles() fiber.Handler
	// EditBodyDesign ...
	EditBodyDesign() fiber.Handler
	// UpdateBodyDesign ...
	UpdateBodyDesign() fiber.Handler
	// EditTitleDesign ...
	EditTitleDesign() fiber.Handler
	// UpdateTitleDesign ...
	UpdateTitleDesign() fiber.Handler
	// NewProfile ...
	NewProfile() fiber.Handler
	// ShowProfile ...
	ShowProfile() fiber.Handler
	// EditProfile ...
	EditProfile() fiber.Handler
	// CreateProfile ...
	CreateProfile() fiber.Handler
	// DeleteProfile ...
	DeleteProfile() fiber.Handler
	// ListEnvironments ...
	ListEnvironments() fiber.Handler
	// NewEnvironment ...
	NewEnvironment() fiber.Handler
	// ShowEnvironment ...
	ShowEnvironment() fiber.Handler
	// EditEnvironment ...
	EditEnvironment() fiber.Handler
	// UpdateEnvironment ...
	UpdateEnvironment() fiber.Handler
	// DeleteEnvironment ...
	DeleteEnvironment() fiber.Handler
	// CreateEnvironment ...
	CreateEnvironment() fiber.Handler
	// ListLenses ...
	ListLenses() fiber.Handler
	// NewLens ...
	NewLens() fiber.Handler
	// ShowLens ...
	ShowLens() fiber.Handler
	// EditLens ...
	EditLens() fiber.Handler
	// UpdateLens ...
	UpdateLens() fiber.Handler
	// DeleteLens ...
	DeleteLens() fiber.Handler
	// ShowSettings ...
	ShowSettings() fiber.Handler
	// CreateWorkload ...
	CreateWorkload() fiber.Handler
	// ListWorkloads ...
	ListWorkloads() fiber.Handler
	// ShowWorkload ...
	ShowWorkload() fiber.Handler
	// EditWorkload ...
	EditWorkload() fiber.Handler
	// NewWorkload ...
	NewWorkload() fiber.Handler
	// UpdateWorkload ...
	// UpdateWorkload() fiber.Handler
	// DeleteWorkload ...
	DeleteWorkload() fiber.Handler
	// ListEnvironmentsPartial ...
	ListEnvironmentsPartial() fiber.Handler
	// ListProfilesPartial ...
	ListProfilesPartial() fiber.Handler
	// ShowWorkloadLens ...
	ShowWorkloadLens() fiber.Handler
	// EditWorkloadLens ...
	EditWorkloadLens() fiber.Handler
	// ShowLensQuestion ...
	ShowLensQuestion() fiber.Handler
	// UpdateWorkloadAnswer ...
	UpdateWorkloadAnswer() fiber.Handler
	// DeleteTag ...
	DeleteTag() fiber.Handler
	// ListWorkflows ...
	ListWorkflows() fiber.Handler
	// Preview ...
	Preview() fiber.Handler
	// ListTemplates ...
	ListTemplates() fiber.Handler
	// NewTemplate ...
	NewTemplate() fiber.Handler
	// CreateTemplate ...
	CreateTemplate() fiber.Handler
	// ShowTemplate ...
	ShowTemplate() fiber.Handler
	// StatsTotalProfiles ...
	StatsTotalProfiles() fiber.Handler
	// StatsTotalDesigns ...
	StatsTotalDesigns() fiber.Handler
	// StatsTotalWorkloads ...
	StatsTotalWorkloads() fiber.Handler
	// SearchLenses ...
	SearchLenses() fiber.Handler
	// SearchProfiles ...
	SearchProfiles() fiber.Handler
	// SearchEnvironments ...
	SearchEnvironments() fiber.Handler
	// CreateWorkflow ...
	CreateWorkflow() fiber.Handler
	// ShowWorkflow ...
	ShowWorkflow() fiber.Handler
	// DeleteDesignCommentReaction ...
	DeleteDesignCommentReaction() fiber.Handler
	// DesignReactions ...
	DesignReactions() fiber.Handler
	// CreateWorkflowStep ...
	CreateWorkflowStep() fiber.Handler
	// UpdateWorkflowSteps ...
	UpdateWorkflowSteps() fiber.Handler
	// DeleteWorkflowStep ...
	DeleteWorkflowStep() fiber.Handler
	// SearchWorkflows ...
	SearchWorkflows() fiber.Handler
	// AddTagDesign ...
	AddTagDesign() fiber.Handler
	// RemoveTagDesign ...
	RemoveTagDesign() fiber.Handler
	// DeleteDesignComment ...
	DeleteDesignComment() fiber.Handler
	// ListDesignRevisions ...
	ListDesignRevisions() fiber.Handler
	// PublishLens ...
	PublishLens() fiber.Handler
	// UnpublishLens ...
	UnpublishLens() fiber.Handler
	// AddTagWorkload ...
	AddTagWorkload() fiber.Handler
	// RemoveTagWorkload ...
	RemoveTagWorkload() fiber.Handler
	// SearchTemplates ...
	SearchTemplates() fiber.Handler
	// Task ...
	Task() fiber.Handler
	// DeleteWorkflow ...
	DeleteWorkflow() fiber.Handler
	// DeleteTemplate ...
	DeleteTemplate() fiber.Handler
	// EditTemplateBody ...
	EditTemplateBody() fiber.Handler
	// UpdateTemplateBody ...
	UpdateTemplateBody() fiber.Handler
	// EditTemplateTitle ...
	EditTemplateTitle() fiber.Handler
	// UpdateTemplateTitle ...
	UpdateTemplateTitle() fiber.Handler
}

Handlers ...

type Migration

type Migration interface {
	// Migrate is a method that runs the migration.
	Migrate(context.Context) error
}

Migration is a method that runs the migration.

type ReadTx

type ReadTx interface {
	// GetUser is a method that returns the profile of the current user
	GetUser(ctx context.Context, user *adapters.GothUser) error
	// GetDesign is a method that returns a design by ID
	GetDesign(ctx context.Context, design *models.Design) error
	// ListDesigns is a method that returns a list of designs
	ListDesigns(ctx context.Context, designs *tables.Results[models.Design]) error
	// ListProfiles is a method that returns a list of profiles
	ListProfiles(ctx context.Context, profiles *tables.Results[models.Profile]) error
	// ListProfileQuestions is a method that returns a list of profile questions
	ListProfileQuestions(ctx context.Context, questions *tables.Results[models.ProfileQuestion]) error
	// GetProfile is a method that returns a profile by ID
	GetProfile(ctx context.Context, profile *models.Profile) error
	// ListEnvironments is a method that returns a list of environments
	ListEnvironments(ctx context.Context, environments *tables.Results[models.Environment]) error
	// GetEnvironment is a method that returns an environment by ID
	GetEnvironment(ctx context.Context, environment *models.Environment) error
	// ListLenses is a method that returns a list of lenses
	ListLenses(ctx context.Context, lenses *tables.Results[models.Lens]) error
	// GetLens is a method that returns a lens by ID
	GetLens(ctx context.Context, lens *models.Lens) error
	// ListWorkloads is a method that returns a list of workloads
	ListWorkloads(ctx context.Context, workloads *tables.Results[models.Workload]) error
	// GetWorkload is a method that returns a workload by ID
	GetWorkload(ctx context.Context, workload *models.Workload) error
	// GetLensQuestion is a method that returns a lens question by ID
	GetLensQuestion(ctx context.Context, question *models.Question) error
	// GetWorkloadAnswer is a method that returns a workload answer by ID
	GetWorkloadAnswer(ctx context.Context, answer *models.WorkloadLensQuestionAnswer) error
	// ListTags is a method that returns a list of tags
	ListTags(ctx context.Context, tags *tables.Results[models.Tag]) error
	// GetWorkflow is a method that returns a workflow by ID
	GetWorkflow(ctx context.Context, workflow *models.Workflow) error
	// ListWorkflows is a method that returns a list of workflows
	ListWorkflows(ctx context.Context, workflows *tables.Results[models.Workflow]) error
	// ListTemplates is a method that returns a list of templates
	ListTemplates(ctx context.Context, templates *tables.Results[models.Template]) error
	// GetTemplate is a method that returns a template by ID
	GetTemplate(ctx context.Context, template *models.Template) error
	// GetTotalNumberOfProfiles is a method that returns the total number of profiles
	GetTotalNumberOfProfiles(ctx context.Context, total *int64) error
	// GetTotalNumberOfDesigns is a method that returns the total number of designs
	GetTotalNumberOfDesigns(ctx context.Context, total *int64) error
	// GetTotalNumberOfWorkloads is a method that returns the total number of workloads
	GetTotalNumberOfWorkloads(ctx context.Context, total *int64) error
	// GetDesignComment is a method that returns a design comment by ID
	GetDesignComment(ctx context.Context, comment *models.DesignComment) error
	// ListDesignRevisions is a method that returns a list of design revisions
	ListDesignRevisions(ctx context.Context, designID uuid.UUID, revisions *tables.Results[models.DesignRevision]) error
	// ListLensAnswers is a method that returns a list of lens answers
	ListLensAnswers(ctx context.Context, lensID uuid.UUID, answers *[]models.WorkloadLensQuestionAnswer) error
}

ReadTx provides methods for transactional read operations.

type ReadWriteTx

type ReadWriteTx interface {
	ReadTx

	// CreateDesign is a method that creates a design
	CreateDesign(ctx context.Context, design *models.Design) error
	// DeleteDesign is a method that deletes a design
	DeleteDesign(ctx context.Context, design *models.Design) error
	// UpdateDesign is a method that updates a design
	UpdateDesign(ctx context.Context, design *models.Design) error
	// AddTagDesign is a method that adds a tag to a design
	AddTagDesign(ctx context.Context, designId uuid.UUID, tag *models.Tag) error
	// RemoveTagDesign is a method that removes a tag from a design
	RemoveTagDesign(ctx context.Context, designId uuid.UUID, tag *models.Tag) error
	// CreateDesignComment is a method that creates a design comment
	CreateDesignComment(ctx context.Context, comment *models.DesignComment) error
	// CreateProfile is a method that creates a profile
	CreateProfile(ctx context.Context, profile *models.Profile) error
	// UpdateProfile is a method that updates a profile
	UpdateProfile(ctx context.Context, profile *models.Profile) error
	// DeleteProfile is a method that deletes a profile
	DeleteProfile(ctx context.Context, profile *models.Profile) error
	// CreateEnvironment is a method that creates an environment
	CreateEnvironment(ctx context.Context, environment *models.Environment) error
	// UpdateEnvironment is a method that updates an environment
	UpdateEnvironment(ctx context.Context, environment *models.Environment) error
	// DeleteEnvironment is a method that deletes an environment
	DeleteEnvironment(ctx context.Context, environment *models.Environment) error
	// CreateLens is a method that creates a lens
	CreateLens(ctx context.Context, lens *models.Lens) error
	// UpdateLens is a method that updates a lens
	UpdateLens(ctx context.Context, lens *models.Lens) error
	// DeleteLens is a method that deletes a lens
	DeleteLens(ctx context.Context, lens *models.Lens) error
	// CreateWorkload is a method that creates a workload
	CreateWorkload(ctx context.Context, workload *models.Workload) error
	// UpdateWorkload is a method that updates a workload
	UpdateWorkload(ctx context.Context, workload *models.Workload) error
	// DeleteWorkload is a method that deletes a workload
	DeleteWorkload(ctx context.Context, workload *models.Workload) error
	// UpdateWorkloadAnswer is a method that updates a workload answer
	UpdateWorkloadAnswer(ctx context.Context, answer *models.WorkloadLensQuestionAnswer) error
	// AddTagWorkload is a method that adds a tag to a workload
	AddTagWorkload(ctx context.Context, workloadId uuid.UUID, tag *models.Tag) error
	// RemoveTagWorkload is a method that removes a tag from a workload
	RemoveTagWorkload(ctx context.Context, workloadId uuid.UUID, tag *models.Tag) error
	// CreateTag is a method that creates a tag
	CreateTag(ctx context.Context, tag *models.Tag) error
	// UpdateTag is a method that updates a tag
	UpdateTag(ctx context.Context, tag *models.Tag) error
	// DeleteTag is a method that deletes a tag
	DeleteTag(ctx context.Context, tag *models.Tag) error
	// CreateTemplate is a method that creates a template
	CreateTemplate(ctx context.Context, template *models.Template) error
	// UpdateTemplate is a method that updates a template
	UpdateTemplate(ctx context.Context, template *models.Template) error
	// DeleteTemplate is a method that deletes a template
	DeleteTemplate(ctx context.Context, template *models.Template) error
	// CreateWorkflow is a method that creates a workflow
	CreateWorkflow(ctx context.Context, workflow *models.Workflow) error
	// UpdateWorkflow is a method that updates a workflow
	UpdateWorkflow(ctx context.Context, workflow *models.Workflow) error
	// DeleteWorkflow is a method that deletes a workflow
	DeleteWorkflow(ctx context.Context, workflow *models.Workflow) error
	// CreateReaction is a method that creates a reaction
	CreateReaction(ctx context.Context, reaction *models.Reaction) error
	// DeleteReaction is a method that deletes a reaction
	DeleteReaction(ctx context.Context, reaction *models.Reaction) error
	// CreateWorkflowState is a method that creates a workflow state
	CreateWorkflowState(ctx context.Context, state *models.WorkflowState) error
	// DeleteWorkflowState is a method that deletes a workflow state
	DeleteWorkflowState(ctx context.Context, state *models.WorkflowState) error
	// UpdateWorkflowStateOrder is a method that updates workflow states
	UpdateWorkflowStateOrder(ctx context.Context, workflowId uuid.UUID, states []int) error
	// DeleteDesignComment is a method that deletes a design comment
	DeleteDesignComment(ctx context.Context, comment *models.DesignComment) error
	// PublishLens is a method that publishes a lens
	PublishLens(ctx context.Context, lensID uuid.UUID) error
	// UnpublishLens is a method that unpublishes a lens
	UnpublishLens(ctx context.Context, lensID uuid.UUID) error
}

ReadWriteTx provides methods for transactional read and write operations.