Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Server.CodebaseServer

Contents

Orphan instances

Synopsis

data HTML = HTML
newtype RawHtml = RawHtml {
- unRaw :: ByteString
}
type OpenApiJSON = "openapi.json" :> Get '[JSON] OpenApi
type UnisonAndDocsAPI = UnisonLocalAPI :<|> (OpenApiJSON :<|> Raw)
type UnisonLocalAPI = ("projects" :> ProjectsAPI) :<|> ("ucm" :> UCMAPI)
type CodebaseServerAPI = NamespaceListingAPI :<|> (NamespaceDetailsAPI :<|> (DefinitionsAPI :<|> (FuzzyFindAPI :<|> (TermSummaryAPI :<|> TypeSummaryAPI))))
type ProjectsAPI = ListProjectsEndpoint :<|> (Capture "project-name" ProjectName :> (("branches" :> (ListProjectBranchesEndpoint :<|> (Capture "branch-name" ProjectBranchName :> CodebaseServerAPI))) :<|> ("diff" :> (("terms" :> ProjectDiffTermsEndpoint) :<|> ("types" :> ProjectDiffTypesEndpoint)))))
type ProjectDiffTermsEndpoint = RequiredQueryParam "oldBranchRef" ProjectBranchName :> (RequiredQueryParam "newBranchRef" ProjectBranchName :> (RequiredQueryParam "oldTerm" Name :> (RequiredQueryParam "newTerm" Name :> Get '[JSON] TermDiffResponse)))
type ProjectDiffTypesEndpoint = RequiredQueryParam "oldBranchRef" ProjectBranchName :> (RequiredQueryParam "newBranchRef" ProjectBranchName :> (RequiredQueryParam "oldType" Name :> (RequiredQueryParam "newType" Name :> Get '[JSON] TypeDiffResponse)))
type WebUI = CaptureAll "route" Text :> Get '[HTML] RawHtml
type ServerAPI = ("ui" :> WebUI) :<|> ("api" :> UnisonAndDocsAPI)
type StaticAPI = "static" :> Raw
type Authed api = Capture "token" Text :> api
type AppAPI = StaticAPI :<|> Authed ServerAPI
data BaseUrl = BaseUrl {
- urlHost :: String
- urlToken :: ByteString
- urlPort :: Port
}
data DefinitionReference
- = TermReference (HashQualified Name)
- | TypeReference (HashQualified Name)
- | AbilityConstructorReference (HashQualified Name)
- | DataConstructorReference (HashQualified Name)
data Service
- = ProjectBranchUI (ProjectAndBranch ProjectName ProjectBranchName) Absolute (Maybe DefinitionReference)
- | Api
data URISegment
- = EscapeMe Text
- | DontEscape Text
urlFor :: Service -> BaseUrl -> Text
handleAuth :: ByteString -> Text -> Handler ()
openAPI :: OpenApi
infoObject :: Info
docsBS :: ByteString
unisonAndDocsAPI :: Proxy UnisonAndDocsAPI
api :: Proxy UnisonLocalAPI
serverAPI :: Proxy ServerAPI
appAPI :: Proxy AppAPI
app :: BackendEnv -> Runtime Symbol -> Codebase IO Symbol Ann -> FilePath -> ByteString -> Maybe String -> Application
genToken :: IO ByteString
data Waiter a = Waiter {
- notify :: a -> IO ()
- waitFor :: IO a
}
mkWaiter :: IO (Waiter a)
ucmUIVar :: String
ucmPortVar :: String
ucmHostVar :: String
ucmAllowCorsHost :: String
ucmTokenVar :: String
data CodebaseServerOpts = CodebaseServerOpts {
- token :: Maybe String
- host :: Maybe String
- port :: Maybe Int
- allowCorsHost :: Maybe String
- codebaseUIPath :: Maybe FilePath
}
defaultCodebaseServerOpts :: CodebaseServerOpts
startServer :: BackendEnv -> CodebaseServerOpts -> Runtime Symbol -> Codebase IO Symbol Ann -> (BaseUrl -> IO a) -> IO a
serveIndex :: FilePath -> Handler RawHtml
serveUI :: FilePath -> Server WebUI
corsPolicy :: Maybe String -> Middleware
server :: BackendEnv -> Runtime Symbol -> Codebase IO Symbol Ann -> FilePath -> ByteString -> Server AppAPI
serveUnisonAndDocs :: BackendEnv -> Runtime Symbol -> Codebase IO Symbol Ann -> Server UnisonAndDocsAPI
serveDocs :: Application
serveOpenAPI :: Handler OpenApi
hoistWithAuth :: forall api. HasServer api '[] => Proxy api -> ByteString -> ServerT api Handler -> ServerT (Authed api) Handler
serveProjectsCodebaseServerAPI :: Codebase IO Symbol Ann -> Runtime Symbol -> ProjectName -> ProjectBranchName -> ServerT CodebaseServerAPI (Backend IO)
resolveProjectRoot :: Codebase IO v a -> ProjectAndBranch ProjectName ProjectBranchName -> Backend IO (CausalBranch Transaction)
resolveProjectRootHash :: Codebase IO v a -> ProjectAndBranch ProjectName ProjectBranchName -> Backend IO CausalHash
serveProjectDiffTermsEndpoint :: Codebase IO Symbol Ann -> Runtime Symbol -> ProjectName -> ProjectBranchName -> ProjectBranchName -> Name -> Name -> Backend IO TermDiffResponse
contextForProjectBranch :: Codebase IO v a -> ProjectName -> ProjectBranchName -> Backend IO (PrettyPrintEnvDecl, NameSearch Transaction)
serveProjectDiffTypesEndpoint :: Codebase IO Symbol Ann -> Runtime Symbol -> ProjectName -> ProjectBranchName -> ProjectBranchName -> Name -> Name -> Backend IO TypeDiffResponse
serveProjectsAPI :: Codebase IO Symbol Ann -> Runtime Symbol -> ServerT ProjectsAPI (Backend IO)
serveUnisonLocal :: BackendEnv -> Codebase IO Symbol Ann -> Runtime Symbol -> Server UnisonLocalAPI
backendHandler :: BackendEnv -> Backend IO a -> Handler a

Documentation

data HTML Source #

Constructors

HTML

Instances

Instances details

Accept HTML Source #
Instance details Defined in Unison.Server.CodebaseServer Methods contentType :: Proxy HTML -> MediaType # contentTypes :: Proxy HTML -> NonEmpty MediaType #
MimeRender HTML RawHtml Source #
Instance details Defined in Unison.Server.CodebaseServer Methods mimeRender :: Proxy HTML -> RawHtml -> ByteString #

newtype RawHtml Source #

Constructors

RawHtml
Fields unRaw :: ByteString

Instances

Instances details

MimeRender HTML RawHtml Source #
Instance details Defined in Unison.Server.CodebaseServer Methods mimeRender :: Proxy HTML -> RawHtml -> ByteString #

type OpenApiJSON = "openapi.json" :> Get '[JSON] OpenApi Source #

type UnisonAndDocsAPI = UnisonLocalAPI :<|> (OpenApiJSON :<|> Raw) Source #

type UnisonLocalAPI = ("projects" :> ProjectsAPI) :<|> ("ucm" :> UCMAPI) Source #

type ProjectsAPI = ListProjectsEndpoint :<|> (Capture "project-name" ProjectName :> (("branches" :> (ListProjectBranchesEndpoint :<|> (Capture "branch-name" ProjectBranchName :> CodebaseServerAPI))) :<|> ("diff" :> (("terms" :> ProjectDiffTermsEndpoint) :<|> ("types" :> ProjectDiffTypesEndpoint))))) Source #

type ProjectDiffTermsEndpoint = RequiredQueryParam "oldBranchRef" ProjectBranchName :> (RequiredQueryParam "newBranchRef" ProjectBranchName :> (RequiredQueryParam "oldTerm" Name :> (RequiredQueryParam "newTerm" Name :> Get '[JSON] TermDiffResponse))) Source #

type ProjectDiffTypesEndpoint = RequiredQueryParam "oldBranchRef" ProjectBranchName :> (RequiredQueryParam "newBranchRef" ProjectBranchName :> (RequiredQueryParam "oldType" Name :> (RequiredQueryParam "newType" Name :> Get '[JSON] TypeDiffResponse))) Source #

type WebUI = CaptureAll "route" Text :> Get '[HTML] RawHtml Source #

type ServerAPI = ("ui" :> WebUI) :<|> ("api" :> UnisonAndDocsAPI) Source #

type StaticAPI = "static" :> Raw Source #

type Authed api = Capture "token" Text :> api Source #

type AppAPI = StaticAPI :<|> Authed ServerAPI Source #

data BaseUrl Source #

Constructors

BaseUrl
Fields urlHost :: String urlToken :: ByteString urlPort :: Port

Instances

Instances details

Show BaseUrl Source #
Instance details Defined in Unison.Server.CodebaseServer Methods showsPrec :: Int -> BaseUrl -> ShowS # show :: BaseUrl -> String # showList :: [BaseUrl] -> ShowS #

data DefinitionReference Source #

Constructors

TermReference (HashQualified Name)
TypeReference (HashQualified Name)
AbilityConstructorReference (HashQualified Name)
DataConstructorReference (HashQualified Name)

Instances

Instances details

Show DefinitionReference Source #
Instance details Defined in Unison.Server.CodebaseServer Methods showsPrec :: Int -> DefinitionReference -> ShowS # show :: DefinitionReference -> String # showList :: [DefinitionReference] -> ShowS #

data Service Source #

Constructors

ProjectBranchUI (ProjectAndBranch ProjectName ProjectBranchName) Absolute (Maybe DefinitionReference)
Api

Instances

Instances details

Show Service Source #
Instance details Defined in Unison.Server.CodebaseServer Methods showsPrec :: Int -> Service -> ShowS # show :: Service -> String # showList :: [Service] -> ShowS #

data URISegment Source #

Constructors

EscapeMe Text
DontEscape Text

Instances

Instances details

Show URISegment Source #
Instance details Defined in Unison.Server.CodebaseServer Methods showsPrec :: Int -> URISegment -> ShowS # show :: URISegment -> String # showList :: [URISegment] -> ShowS #

urlFor :: Service -> BaseUrl -> Text Source #

Create a Service URL, either for the UI or the API

Examples:

>>> urlFor Api (BaseUrl{ urlHost = "http://localhost", urlToken = "asdf", urlPort = 1234 })
"http://localhost:1234/asdf/api"

Loose code with definition but no perspective >>> import qualified Unison.Syntax.Name as Name >>> let service = LooseCodeUI (Path.absoluteEmpty) (Just (TermReference (NameOnly (Name.unsafeFromText "base.data.List.map")))) >>> let baseUrl = (BaseUrl{ urlHost = "http://localhost", urlToken = "asdf", urlPort = 1234 }) >>> urlFor service baseUrl "http://localhost:1234/asdf/ui/non-project-code/latest/terms/base/data/List/map"

Loose code with definition and perspective >>> import qualified Unison.Syntax.Name as Name >>> let service = LooseCodeUI (Path.Absolute (Path.fromText "base.data")) (Just (TermReference (NameOnly (Name.unsafeFromText "List.map")))) >>> let baseUrl = (BaseUrl{ urlHost = "http://localhost", urlToken = "asdf", urlPort = 1234 }) >>> urlFor service baseUrl "http://localhost:1234/asdf/ui/non-project-code/latest/namespaces/base/data/;/terms/List/map"

Project with definition but no perspective >>> import qualified Unison.Syntax.Name as Name >>> import Unison.Core.Project (ProjectName (..), ProjectBranchName (..), ProjectAndBranch (..)) >>> let service = ProjectBranchUI (ProjectAndBranch (UnsafeProjectName "base") (UnsafeProjectBranchName "main")) (Path.empty) (Just (TermReference (NameOnly (Name.unsafeFromText "List.map")))) >>> let baseUrl = (BaseUrl{ urlHost = "http://localhost", urlToken = "asdf", urlPort = 1234 }) >>> urlFor service baseUrl "http://localhost:1234/asdf/ui/projects/base/main/latest/terms/List/map"

Project with definition but no perspective, contributor branch >>> import qualified Unison.Syntax.Name as Name >>> import Unison.Core.Project (ProjectName (..), ProjectBranchName (..), ProjectAndBranch (..)) >>> let service = ProjectBranchUI (ProjectAndBranch (UnsafeProjectName "unison/base") (UnsafeProjectBranchName "runarorama/contribution")) (Path.empty) (Just (TermReference (NameOnly (Name.unsafeFromText "List.map")))) >>> let baseUrl = (BaseUrl{ urlHost = "http://localhost", urlToken = "asdf", urlPort = 1234 }) >>> urlFor service baseUrl "http://localhost:1234/asdf/ui/projects/@unison/base/@runarorama/contribution/latest/terms/List/map"

Project with definition and perspective >>> import qualified Unison.Syntax.Name as Name >>> import Unison.Core.Project (ProjectName (..), ProjectBranchName (..), ProjectAndBranch (..)) >>> let service = ProjectBranchUI (ProjectAndBranch (UnsafeProjectName "unison/base") (UnsafeProjectBranchName "runarorama/contribution")) (Path.fromList ["data"]) (Just (TermReference (NameOnly (Name.unsafeFromText "List.map")))) >>> let baseUrl = (BaseUrl{ urlHost = "http://localhost", urlToken = "asdf", urlPort = 1234 }) >>> urlFor service baseUrl "http://localhost:1234/asdf/ui/projects/@unison/base/@runarorama/contribution/latest/namespaces/data/;/terms/List/map"

handleAuth :: ByteString -> Text -> Handler () Source #

openAPI :: OpenApi Source #

infoObject :: Info Source #

docsBS :: ByteString Source #

unisonAndDocsAPI :: Proxy UnisonAndDocsAPI Source #

api :: Proxy UnisonLocalAPI Source #

serverAPI :: Proxy ServerAPI Source #

appAPI :: Proxy AppAPI Source #

app :: BackendEnv -> Runtime Symbol -> Codebase IO Symbol Ann -> FilePath -> ByteString -> Maybe String -> Application Source #

genToken :: IO ByteString Source #

The Token is used to help prevent multiple users on a machine gain access to each others codebases.

Generate a cryptographically secure random token. https://neilmadden.blog/2018/08/30/moving-away-from-uuids/

E.g. >>> genToken "uxf85C7Y0B6om47"

data Waiter a Source #

Constructors

Waiter
Fields notify :: a -> IO () waitFor :: IO a

mkWaiter :: IO (Waiter a) Source #

ucmUIVar :: String Source #

ucmPortVar :: String Source #

ucmHostVar :: String Source #

ucmAllowCorsHost :: String Source #

ucmTokenVar :: String Source #

data CodebaseServerOpts Source #

Constructors

CodebaseServerOpts
Fields token :: Maybe String host :: Maybe String port :: Maybe Int allowCorsHost :: Maybe String codebaseUIPath :: Maybe FilePath

Instances

Instances details

Show CodebaseServerOpts Source #
Instance details Defined in Unison.Server.CodebaseServer Methods showsPrec :: Int -> CodebaseServerOpts -> ShowS # show :: CodebaseServerOpts -> String # showList :: [CodebaseServerOpts] -> ShowS #
Eq CodebaseServerOpts Source #
Instance details Defined in Unison.Server.CodebaseServer Methods (==) :: CodebaseServerOpts -> CodebaseServerOpts -> Bool # (/=) :: CodebaseServerOpts -> CodebaseServerOpts -> Bool #

defaultCodebaseServerOpts :: CodebaseServerOpts Source #

startServer :: BackendEnv -> CodebaseServerOpts -> Runtime Symbol -> Codebase IO Symbol Ann -> (BaseUrl -> IO a) -> IO a Source #

serveIndex :: FilePath -> Handler RawHtml Source #

serveUI :: FilePath -> Server WebUI Source #

corsPolicy :: Maybe String -> Middleware Source #

server :: BackendEnv -> Runtime Symbol -> Codebase IO Symbol Ann -> FilePath -> ByteString -> Server AppAPI Source #

serveUnisonAndDocs :: BackendEnv -> Runtime Symbol -> Codebase IO Symbol Ann -> Server UnisonAndDocsAPI Source #

serveDocs :: Application Source #

serveOpenAPI :: Handler OpenApi Source #

hoistWithAuth :: forall api. HasServer api '[] => Proxy api -> ByteString -> ServerT api Handler -> ServerT (Authed api) Handler Source #

serveProjectsCodebaseServerAPI :: Codebase IO Symbol Ann -> Runtime Symbol -> ProjectName -> ProjectBranchName -> ServerT CodebaseServerAPI (Backend IO) Source #

resolveProjectRoot :: Codebase IO v a -> ProjectAndBranch ProjectName ProjectBranchName -> Backend IO (CausalBranch Transaction) Source #

resolveProjectRootHash :: Codebase IO v a -> ProjectAndBranch ProjectName ProjectBranchName -> Backend IO CausalHash Source #

serveProjectDiffTermsEndpoint :: Codebase IO Symbol Ann -> Runtime Symbol -> ProjectName -> ProjectBranchName -> ProjectBranchName -> Name -> Name -> Backend IO TermDiffResponse Source #

contextForProjectBranch :: Codebase IO v a -> ProjectName -> ProjectBranchName -> Backend IO (PrettyPrintEnvDecl, NameSearch Transaction) Source #

serveProjectDiffTypesEndpoint :: Codebase IO Symbol Ann -> Runtime Symbol -> ProjectName -> ProjectBranchName -> ProjectBranchName -> Name -> Name -> Backend IO TypeDiffResponse Source #

serveProjectsAPI :: Codebase IO Symbol Ann -> Runtime Symbol -> ServerT ProjectsAPI (Backend IO) Source #

serveUnisonLocal :: BackendEnv -> Codebase IO Symbol Ann -> Runtime Symbol -> Server UnisonLocalAPI Source #

backendHandler :: BackendEnv -> Backend IO a -> Handler a Source #

Orphan instances

ToSample Char Source #
Instance details Methods toSamples :: Proxy Char -> [(Text, Char)] #
ToParam (QueryParam' mods "newBranchRef" a :: Type) Source #
Instance details Methods toParam :: Proxy (QueryParam' mods "newBranchRef" a) -> DocQueryParam #
ToParam (QueryParam' mods "newTerm" a :: Type) Source #
Instance details Methods toParam :: Proxy (QueryParam' mods "newTerm" a) -> DocQueryParam #
ToParam (QueryParam' mods "newType" a :: Type) Source #
Instance details Methods toParam :: Proxy (QueryParam' mods "newType" a) -> DocQueryParam #
ToParam (QueryParam' mods "oldBranchRef" a :: Type) Source #
Instance details Methods toParam :: Proxy (QueryParam' mods "oldBranchRef" a) -> DocQueryParam #
ToParam (QueryParam' mods "oldTerm" a :: Type) Source #
Instance details Methods toParam :: Proxy (QueryParam' mods "oldTerm" a) -> DocQueryParam #
ToParam (QueryParam' mods "oldType" a :: Type) Source #
Instance details Methods toParam :: Proxy (QueryParam' mods "oldType" a) -> DocQueryParam #