Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.Npm.Wire

Contents

Shared scalars
The dist object
Per-version manifest

Description

The npm wire JSON types and their decoders: the decode-only protocol boundary.

Every decoder is lenient in the ways the public registry requires. Unknown keys are ignored, license and a person arrive as a string or an object, deprecated as a string or a boolean, and an undecodable advisory unpackedSize reads as absent rather than failing the version. The shapes come from live captures of registry.npmjs.org, kept as fixtures under core/test/unit/fixtures/npm/.

Synopsis

data Person = Person {
- personName :: Text
- personEmail :: Maybe Text
- personUrl :: Maybe Text
}
data License
- = LicenseSpdx Text
- | LicenseObject Text (Maybe Text)
data Dist = Dist {
- distTarball :: Text
- distShasum :: Maybe Text
- distIntegrity :: Maybe Text
- distUnpackedSize :: Maybe Int
}
distFields :: [Text]
data VersionManifest = VersionManifest {
- vmName :: Text
- vmVersion :: Text
- vmDist :: Dist
- vmDeprecated :: Maybe Text
- vmHasInstallScript :: Maybe Bool
- vmScripts :: Map Text Text
- vmLicense :: Maybe License
}

Shared scalars

data Person Source #

A person on a package: an author, maintainer, contributor, or a version's publisher. A packed "Name <email> (url)" string, npm's other form, stays verbatim in personName.

Constructors

Person
Fields personName :: Text The name, or the whole packed string as sent. personEmail :: Maybe Text personUrl :: Maybe Text

Instances

Instances details

FromJSON Person Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods parseJSON :: Value -> Parser Person # parseJSONList :: Value -> Parser [Person] # omittedField :: Maybe Person #
Show Person Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods showsPrec :: Int -> Person -> ShowS # show :: Person -> String # showList :: [Person] -> ShowS #
Eq Person Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods (==) :: Person -> Person -> Bool # (/=) :: Person -> Person -> Bool #
Ord Person Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods compare :: Person -> Person -> Ordering # (<) :: Person -> Person -> Bool # (<=) :: Person -> Person -> Bool # (>) :: Person -> Person -> Bool # (>=) :: Person -> Person -> Bool # max :: Person -> Person -> Person # min :: Person -> Person -> Person #

data License Source #

A declared license, in npm's modern string form or its legacy object form.

Constructors

LicenseSpdx Text	An SPDX expression or identifier (`MIT`, `"(MIT OR Apache-2.0)"`).
LicenseObject Text (Maybe Text)	The legacy `{type, url?}` object: a license name and a URL to its text.

Instances

Instances details

FromJSON License Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods parseJSON :: Value -> Parser License # parseJSONList :: Value -> Parser [License] # omittedField :: Maybe License #
Show License Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods showsPrec :: Int -> License -> ShowS # show :: License -> String # showList :: [License] -> ShowS #
Eq License Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods (==) :: License -> License -> Bool # (/=) :: License -> License -> Bool #
Ord License Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods compare :: License -> License -> Ordering # (<) :: License -> License -> Bool # (<=) :: License -> License -> Bool # (>) :: License -> License -> Bool # (>=) :: License -> License -> Bool # max :: License -> License -> License # min :: License -> License -> License #

The `dist` object

data Dist Source #

The artifact descriptor every version manifest carries. A client fails the install when the bytes mismatch, so a mirror or a URL rewrite preserves the digests byte for byte.

Constructors

Dist

Fields

distTarball :: Text
Absolute URL of the .tgz artifact. Always present.
distShasum :: Maybe Text
The tarball's SHA-1, hex-encoded (legacy integrity).
distIntegrity :: Maybe Text
The Subresource-Integrity string ("sha512-..."), preferred over the shasum.
distUnpackedSize :: Maybe Int
Unpacked size in bytes. Advisory, so a fractional, huge, or wrong-typed value reads as Nothing instead of denying the whole packument.

Instances

Instances details

FromJSON Dist Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods parseJSON :: Value -> Parser Dist # parseJSONList :: Value -> Parser [Dist] # omittedField :: Maybe Dist #
Show Dist Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods showsPrec :: Int -> Dist -> ShowS # show :: Dist -> String # showList :: [Dist] -> ShowS #
Eq Dist Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods (==) :: Dist -> Dist -> Bool # (/=) :: Dist -> Dist -> Bool #
Ord Dist Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods compare :: Dist -> Dist -> Ordering # (<) :: Dist -> Dist -> Bool # (<=) :: Dist -> Dist -> Bool # (>) :: Dist -> Dist -> Bool # (>=) :: Dist -> Dist -> Bool # max :: Dist -> Dist -> Dist # min :: Dist -> Dist -> Dist #

distFields :: [Text] Source #

The dist members the Dist parser reads.

Per-version manifest

data VersionManifest Source #

One version's manifest, decoding all three wire forms alike. The dependency maps and the maintainer list stay unparsed: nothing reads them, and the cost falls on every version.

Constructors

VersionManifest

Fields

vmName :: Text
The package name as sent, possibly scoped ("@scope/name").
vmVersion :: Text
The exact version string, kept opaque at this layer.
vmDist :: Dist
vmDeprecated :: Maybe Text
The deprecation message. A boolean true reads as "", and false, null, absence, or any other shape as Nothing.
vmHasInstallScript :: Maybe Bool
Abbreviated form only. Nothing in the full form, where vmScripts carries it.
vmScripts :: Map Text Text
The scripts map, lifecycle name to command, empty when absent.
vmLicense :: Maybe License

Instances

Instances details

FromJSON VersionManifest Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods parseJSON :: Value -> Parser VersionManifest # parseJSONList :: Value -> Parser [VersionManifest] # omittedField :: Maybe VersionManifest #
Show VersionManifest Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods showsPrec :: Int -> VersionManifest -> ShowS # show :: VersionManifest -> String # showList :: [VersionManifest] -> ShowS #
Eq VersionManifest Source #
Instance details Defined in Ecluse.Core.Registry.Npm.Wire Methods (==) :: VersionManifest -> VersionManifest -> Bool # (/=) :: VersionManifest -> VersionManifest -> Bool #

Shared scalars

Instances

Instances

The dist object

Instances

Per-version manifest

Instances

The `dist` object