repository

type CreateProjectRequest struct {
	Project models.Project
}

type CreateProjectResponse struct {
	ProjectID string
	Project   models.Project
	Cursor    string
}

type DeleteProjectRequest struct {
	ProjectID string
}

type DeleteProjectResponse struct {
}

type ProjectAlreadyExistsError struct {
	Err error
}

type ProjectNotFoundError struct {
	ProjectID string
	Err       error
}

type ReadProjectRequest struct {
	ProjectID string
}

type ReadProjectResponse struct {
	Project models.Project
}

type RepositoryContract interface {
	// CreateProject creates a new project.
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to create a new project
	// Returns either the result of creating new project or error if something goes wrong.
	CreateProject(
		ctx context.Context,
		request *CreateProjectRequest) (*CreateProjectResponse, error)

	// ReadProject read an existing project
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to read an esiting project
	// Returns either the result of reading an exiting project or error if something goes wrong.
	ReadProject(
		ctx context.Context,
		request *ReadProjectRequest) (*ReadProjectResponse, error)

	// UpdateProject update an existing project
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to update an esiting project
	// Returns either the result of updateing an exiting project or error if something goes wrong.
	UpdateProject(
		ctx context.Context,
		request *UpdateProjectRequest) (*UpdateProjectResponse, error)

	// DeleteProject delete an existing project
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to delete an esiting project
	// Returns either the result of deleting an exiting project or error if something goes wrong.
	DeleteProject(
		ctx context.Context,
		request *DeleteProjectRequest) (*DeleteProjectResponse, error)

	// Search returns the list of projects that matched the criteria
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request contains the search criteria
	// Returns the list of projects that matched the criteria
	Search(
		ctx context.Context,
		request *SearchRequest) (*SearchResponse, error)
}

type SearchRequest struct {
	Pagination     common.Pagination
	SortingOptions []common.SortingOptionPair
	ProjectIDs     []string
}

type SearchResponse struct {
	HasPreviousPage bool
	HasNextPage     bool
	TotalCount      int64
	Projects        []models.ProjectWithCursor
}

type UnknownError struct {
	Message string
	Err     error
}

type UpdateProjectRequest struct {
	ProjectID string
	Project   models.Project
}

type UpdateProjectResponse struct {
	Project models.Project
	Cursor  string
}