| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Ecluse.Core.Registry.Npm.Request
Description
npm request paths, metadata negotiation and credentials over shared HTTP mechanics.
Synopsis
- data MetadataForm
- = Abbreviated
- | Full
- npmArtifactHosts :: [Text]
- metadataRequest :: Text -> Maybe ClientCredential -> MetadataForm -> PackageName -> Either UrlFormationError Request
- metadataRequestUnder :: BaseRequest -> Maybe ClientCredential -> MetadataForm -> PackageName -> Either UrlFormationError Request
- artifactRequestByFile :: BaseRequest -> Maybe ClientCredential -> PackageName -> Text -> Either UrlFormationError Request
- artifactRequestByUrl :: Maybe ClientCredential -> Text -> Either UrlFormationError Request
- artifactFileUrl :: Text -> PackageName -> Text -> Either UrlFormationError Text
- packageUrl :: Text -> PackageName -> Either UrlFormationError Text
- jsonPutRequest :: Maybe ClientCredential -> Text -> ByteString -> Either UrlFormationError Request
- withToken :: Maybe ClientCredential -> Request -> Request
Content negotiation
data MetadataForm Source #
Which of npm's two metadata documents to request, selected by the Accept header.
Constructors
| Abbreviated | The install view ( |
| Full | The full packument ( |
Instances
| Show MetadataForm Source # | |
Defined in Ecluse.Core.Registry.Npm.Request Methods showsPrec :: Int -> MetadataForm -> ShowS # show :: MetadataForm -> String # showList :: [MetadataForm] -> ShowS # | |
| Eq MetadataForm Source # | |
Defined in Ecluse.Core.Registry.Npm.Request | |
The ecosystem's artifact hosts
npmArtifactHosts :: [Text] Source #
npm registries serve their own artifacts, so no extra hosts enter the artifact gate.
Request building
metadataRequest :: Text -> Maybe ClientCredential -> MetadataForm -> PackageName -> Either UrlFormationError Request Source #
Fetch {baseUrl}/{encoded-name} with the requested metadata form and gzip negotiation.
metadataRequestUnder :: BaseRequest -> Maybe ClientCredential -> MetadataForm -> PackageName -> Either UrlFormationError Request Source #
metadataRequest under a base parsed once, through requestAt.
artifactRequestByFile :: BaseRequest -> Maybe ClientCredential -> PackageName -> Text -> Either UrlFormationError Request Source #
Fetch {base}{encoded-pkg}-/{filename} under the client's filename through requestAt.
artifactRequestByUrl :: Maybe ClientCredential -> Text -> Either UrlFormationError Request Source #
Fetch the preserved dist.tarball URL under npm's credential presentation.
artifactFileUrl :: Text -> PackageName -> Text -> Either UrlFormationError Text Source #
Encode the filename as one component in {baseUrl}{encoded-name}-/{encoded-filename}.
packageUrl :: Text -> PackageName -> Either UrlFormationError Text Source #
The metadata and publish URL for a package: {baseUrl}/{encoded-name}.
Shared internals
jsonPutRequest :: Maybe ClientCredential -> Text -> ByteString -> Either UrlFormationError Request Source #
Publish JSON under the injected credential, declaring the media type npm registries require.