Data.Stac

getCollections :: String -> Effect (Promise (Either Error CollectionsResponse))

Fetch the /collections route from a STAC API.

newtype StacCollection

A StacCollection represents a logical grouping of items and other collections / and catalogs that shares some metadata, namely, temporal and geographic extents and upstream providers.

Constructors

• StacCollection { description :: String, extensionFields :: Object Json, extent :: StacExtent, id :: String, keywords :: Array String, license :: String, links :: Array StacLink, properties :: Json, providers :: Array StacProvider, stacExtensions :: Array String, stacVersion :: String, summaries :: Json, title :: Maybe String }

Instances

• DecodeJson StacCollection
• EncodeJson StacCollection
• Arbitrary StacCollection
• Eq StacCollection
• Show StacCollection

newtype CollectionsResponse

A CollectionsResponse models the format of responses from the /collections route required of STAC APIs.

Constructors

• CollectionsResponse { collections :: Array StacCollection, links :: Array StacLink }

Instances

• Semigroup CollectionsResponse
• Monoid CollectionsResponse
• DecodeJson CollectionsResponse
• EncodeJson CollectionsResponse
• Arbitrary CollectionsResponse
• Eq CollectionsResponse
• Show CollectionsResponse

newtype TwoDimBbox

A TwoDimBbox represents a bounding box in two dimensions.

Constructors

• TwoDimBbox { llx :: Number, lly :: Number, urx :: Number, ury :: Number }

Instances

• Eq TwoDimBbox
• Show TwoDimBbox
• DecodeJson TwoDimBbox
• EncodeJson TwoDimBbox
• Arbitrary TwoDimBbox

newtype TemporalExtent

A TemporalExtent represents the time span covered by a StacCollection. It can be open on no more than one side.

Constructors

• TemporalExtent (Refined (OneOrBoth JsonDate) (Array (Maybe JsonDate)))

Instances

• Eq TemporalExtent
• Show TemporalExtent
• DecodeJson TemporalExtent
• EncodeJson TemporalExtent
• Arbitrary TemporalExtent

type StacExtent = { spatial :: SpatialExtent, temporal :: Interval }

A StacExtent represents the combined time and geographic extents covered by a StacCollection.

type SpatialExtent = { bbox :: Array TwoDimBbox }

A SpatialExtent represents the collection of two dimensional bboxes covered by a collection.

data OneOrBoth a

Predicate requiring at least one non-Nothing item in a list of two items. The implementation implies SizeEqualTo D2 but I don't know how to express that predicate as a dependency.

Instances

• Predicate (OneOrBoth p) (Array (Maybe x))

type Interval = { interval :: Array TemporalExtent }

An Interval represents the collection of time spans covered by a StacCollection.

newtype JsonDate

Constructors

• JsonDate DateTime

Instances

• Show JsonDate
• Eq JsonDate
• Arbitrary JsonDate
• DecodeJson JsonDate
• EncodeJson JsonDate

fromString :: String -> Either String JsonDate

newtype StacLink

Links from one STAC entity to somewhere else. "Somewhere else" can be another STAC entity, for example, a collection linking to a child catalog or an item, or to somewhere else entirely, for example an item could link to a specially formatted metadata file. See the STAC specification

Constructors

• StacLink { _type :: Maybe String, extensionFields :: Object Json, href :: String, rel :: StacLinkType, title :: Maybe String }

Instances

• Eq StacLink
• Show StacLink
• DecodeJson StacLink
• EncodeJson StacLink
• Arbitrary StacLink

data StacProviderRole

A ProviderRole indicates what a provider was responsible for in the provenance of some data.

Constructors

• Licensor
• Producer
• Processor
• Host

Instances

• Eq StacProviderRole
• Show StacProviderRole
• DecodeJson StacProviderRole
• EncodeJson StacProviderRole
• Arbitrary StacProviderRole

type StacProvider = { description :: Maybe String, name :: String, roles :: Array StacProviderRole, url :: Maybe String }

A StacProvider indicates the name and responsibilities of entities responsible for some piece of the data's provenance. More information can be found in the STAC specification.

data StacLinkType

STAC link types model many possible STAC link types based on the Some link relation types are explicitly mentioned in the STAC specification, but a more complete list of suggestions can be found in IANA link relations. Link types that do not have a specific constructor will be parsed as VendorLinkType linkTypeString.

Constructors

• Self
• StacRoot
• Parent
• Child
• Item
• Items
• Source
• Collection
• License
• Alternate
• DescribedBy
• Next
• Prev
• ServiceDesc
• ServiceDoc
• Conformance
• Data
• LatestVersion
• PredecessorVersion
• SuccessorVersion
• DerivedFrom
• VendorLinkType String

Instances

• Eq StacLinkType
• Generic StacLinkType _
• Show StacLinkType
• DecodeJson StacLinkType
• EncodeJson StacLinkType
• Arbitrary StacLinkType

maybe :: forall a. Gen a -> Gen (Maybe a)

jsObjectGen :: Gen (Object Json)

alphaStringGen :: Int -> Gen String