Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Cli.Share.Projects

Contents

API types
API functions
Temporary special hard-coded base url

Description

This module contains Share API calls related to projects, wrapped in the Cli monad.

Here, we also validate inputs from Share that the API itself does not. For example, in the API, a project name is just a Text. But because our client requires a richer structure for project names, we try parsing them into a ProjectName, and fail right away if parsing fails.

Synopsis

data RemoteProject = RemoteProject {
- projectId :: RemoteProjectId
- projectName :: ProjectName
- latestRelease :: Maybe Semver
}
data RemoteProjectBranch = RemoteProjectBranch {
- projectId :: RemoteProjectId
- projectName :: ProjectName
- branchId :: RemoteProjectBranchId
- branchName :: ProjectBranchName
- branchHead :: HashJWT
- squashedBranchHead :: Maybe HashJWT
}
getProjectById :: RemoteProjectId -> Cli (Maybe RemoteProject)
getProjectByName :: ProjectName -> Cli (Maybe RemoteProject)
getProjectByName' :: ProjectName -> Cli (Either ClientError (Maybe RemoteProject))
createProject :: ProjectName -> Cli (Maybe RemoteProject)
data GetProjectBranchResponse
data IncludeSquashedHead
- = IncludeSquashedHead
- | NoSquashedHead
getProjectBranchById :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId RemoteProjectBranchId -> Cli GetProjectBranchResponse
getProjectBranchByName :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId ProjectBranchName -> Cli GetProjectBranchResponse
getProjectBranchByName' :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId ProjectBranchName -> Cli (Either ClientError GetProjectBranchResponse)
createProjectBranch :: CreateProjectBranchRequest -> Cli (Maybe RemoteProjectBranch)
data SetProjectBranchHeadResponse
setProjectBranchHead :: SetProjectBranchHeadRequest -> Cli SetProjectBranchHeadResponse
hardCodedBaseUrl :: BaseUrl
hardCodedUri :: URI

API types

data RemoteProject Source #

A remote project.

Constructors

RemoteProject
Fields projectId :: RemoteProjectId projectName :: ProjectName latestRelease :: Maybe Semver

Instances

Instances details

Generic RemoteProject Source #
Instance details Defined in Unison.Cli.Share.Projects.Types Associated Types type Rep RemoteProject :: Type -> Type # Methods from :: RemoteProject -> Rep RemoteProject x # to :: Rep RemoteProject x -> RemoteProject #
Show RemoteProject Source #
Instance details Defined in Unison.Cli.Share.Projects.Types Methods showsPrec :: Int -> RemoteProject -> ShowS # show :: RemoteProject -> String # showList :: [RemoteProject] -> ShowS #
Eq RemoteProject Source #
Instance details Defined in Unison.Cli.Share.Projects.Types Methods (==) :: RemoteProject -> RemoteProject -> Bool # (/=) :: RemoteProject -> RemoteProject -> Bool #
type Rep RemoteProject Source #
Instance details Defined in Unison.Cli.Share.Projects.Types type Rep RemoteProject = D1 ('MetaData "RemoteProject" "Unison.Cli.Share.Projects.Types" "unison-cli-0.0.0-9ca51USbfnvJ69M3lqQhft" 'False) (C1 ('MetaCons "RemoteProject" 'PrefixI 'True) (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemoteProjectId) :: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectName) :: S1 ('MetaSel ('Just "latestRelease") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Semver)))))

data RemoteProjectBranch Source #

A remote project branch.

Constructors

RemoteProjectBranch
Fields projectId :: RemoteProjectId projectName :: ProjectName branchId :: RemoteProjectBranchId branchName :: ProjectBranchName branchHead :: HashJWT squashedBranchHead :: Maybe HashJWT

Instances

Instances details

Generic RemoteProjectBranch Source #
Instance details Defined in Unison.Cli.Share.Projects.Types Associated Types type Rep RemoteProjectBranch :: Type -> Type # Methods from :: RemoteProjectBranch -> Rep RemoteProjectBranch x # to :: Rep RemoteProjectBranch x -> RemoteProjectBranch #
Show RemoteProjectBranch Source #
Instance details Defined in Unison.Cli.Share.Projects.Types Methods showsPrec :: Int -> RemoteProjectBranch -> ShowS # show :: RemoteProjectBranch -> String # showList :: [RemoteProjectBranch] -> ShowS #
Eq RemoteProjectBranch Source #
Instance details Defined in Unison.Cli.Share.Projects.Types Methods (==) :: RemoteProjectBranch -> RemoteProjectBranch -> Bool # (/=) :: RemoteProjectBranch -> RemoteProjectBranch -> Bool #
type Rep RemoteProjectBranch Source #
Instance details Defined in Unison.Cli.Share.Projects.Types type Rep RemoteProjectBranch = D1 ('MetaData "RemoteProjectBranch" "Unison.Cli.Share.Projects.Types" "unison-cli-0.0.0-9ca51USbfnvJ69M3lqQhft" 'False) (C1 ('MetaCons "RemoteProjectBranch" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemoteProjectId) :: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectName) :: S1 ('MetaSel ('Just "branchId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemoteProjectBranchId))) :: (S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectBranchName) :: (S1 ('MetaSel ('Just "branchHead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashJWT) :*: S1 ('MetaSel ('Just "squashedBranchHead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HashJWT))))))

API functions

getProjectById :: RemoteProjectId -> Cli (Maybe RemoteProject) Source #

Get a project by id.

On success, update the remote_project table.

getProjectByName :: ProjectName -> Cli (Maybe RemoteProject) Source #

Get a project by name.

On success, update the remote_project table.

getProjectByName' :: ProjectName -> Cli (Either ClientError (Maybe RemoteProject)) Source #

Variant of getProjectByName that returns servant client errors.

createProject :: ProjectName -> Cli (Maybe RemoteProject) Source #

Create a new project. Kinda weird: returns Nothing if the user handle part of the project doesn't exist.

On success, update the remote_project table.

data GetProjectBranchResponse Source #

Constructors

GetProjectBranchResponseBranchNotFound
GetProjectBranchResponseProjectNotFound
GetProjectBranchResponseSuccess !RemoteProjectBranch

data IncludeSquashedHead Source #

Constructors

IncludeSquashedHead
NoSquashedHead

Instances

Instances details

Show IncludeSquashedHead Source #
Instance details Defined in Unison.Cli.Share.Projects Methods showsPrec :: Int -> IncludeSquashedHead -> ShowS # show :: IncludeSquashedHead -> String # showList :: [IncludeSquashedHead] -> ShowS #
Eq IncludeSquashedHead Source #
Instance details Defined in Unison.Cli.Share.Projects Methods (==) :: IncludeSquashedHead -> IncludeSquashedHead -> Bool # (/=) :: IncludeSquashedHead -> IncludeSquashedHead -> Bool #

getProjectBranchById :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId RemoteProjectBranchId -> Cli GetProjectBranchResponse Source #

Get a project branch by id.

On success, update the remote_project_branch table.

getProjectBranchByName :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId ProjectBranchName -> Cli GetProjectBranchResponse Source #

Get a project branch by name.

On success, update the remote_project_branch table.

getProjectBranchByName' :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId ProjectBranchName -> Cli (Either ClientError GetProjectBranchResponse) Source #

Variant of getProjectBranchByName that returns servant client errors.

createProjectBranch :: CreateProjectBranchRequest -> Cli (Maybe RemoteProjectBranch) Source #

Create a new project branch.

On success, update the remote_project_branch table.

data SetProjectBranchHeadResponse Source #

Constructors

SetProjectBranchHeadResponseNotFound
SetProjectBranchHeadResponseExpectedCausalHashMismatch !Hash32 !Hash32	(expected, actual)
SetProjectBranchHeadResponsePublishedReleaseIsImmutable
SetProjectBranchHeadResponseDeprecatedReleaseIsImmutable
SetProjectBranchHeadResponseSuccess

Instances

Instances details

Generic SetProjectBranchHeadResponse Source #
Instance details Defined in Unison.Cli.Share.Projects Associated Types type Rep SetProjectBranchHeadResponse :: Type -> Type # Methods from :: SetProjectBranchHeadResponse -> Rep SetProjectBranchHeadResponse x # to :: Rep SetProjectBranchHeadResponse x -> SetProjectBranchHeadResponse #
Show SetProjectBranchHeadResponse Source #
Instance details Defined in Unison.Cli.Share.Projects Methods showsPrec :: Int -> SetProjectBranchHeadResponse -> ShowS # show :: SetProjectBranchHeadResponse -> String # showList :: [SetProjectBranchHeadResponse] -> ShowS #
Eq SetProjectBranchHeadResponse Source #
Instance details Defined in Unison.Cli.Share.Projects Methods (==) :: SetProjectBranchHeadResponse -> SetProjectBranchHeadResponse -> Bool # (/=) :: SetProjectBranchHeadResponse -> SetProjectBranchHeadResponse -> Bool #
type Rep SetProjectBranchHeadResponse Source #
Instance details Defined in Unison.Cli.Share.Projects type Rep SetProjectBranchHeadResponse = D1 ('MetaData "SetProjectBranchHeadResponse" "Unison.Cli.Share.Projects" "unison-cli-0.0.0-9ca51USbfnvJ69M3lqQhft" 'False) ((C1 ('MetaCons "SetProjectBranchHeadResponseNotFound" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SetProjectBranchHeadResponseExpectedCausalHashMismatch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash32) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash32))) :+: (C1 ('MetaCons "SetProjectBranchHeadResponsePublishedReleaseIsImmutable" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SetProjectBranchHeadResponseDeprecatedReleaseIsImmutable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SetProjectBranchHeadResponseSuccess" 'PrefixI 'False) (U1 :: Type -> Type))))

setProjectBranchHead :: SetProjectBranchHeadRequest -> Cli SetProjectBranchHeadResponse Source #

Set a project branch head (can be a fast-forward or force-push).

Temporary special hard-coded base url

hardCodedBaseUrl :: BaseUrl Source #

hardCodedUri :: URI Source #