ssd-access

Access to Spatial Service Discovery of Open Spatial Computing Platform

Usage no npm install needed!

<script type="module">
  import ssdAccess from 'https://cdn.skypack.dev/ssd-access';
</script>

README

Simple library aiming to make access to the spatial service discovery as easy as possible. Currently, verifying if it actually makes sense.

This module will very likely only run in a browser using rollup and snowpack right now. Compatibility with other packagers and with Node on the server side is planned.

New with this version:

  • Implementing changes from SSD
  • Breaking: Rename service property capabilities to properties
  • Add new property active

Currently available functions are:

getServicesAtLocation(countryCode, h3Index)

Requests services available around H3Index from the regional server for the provided countryCode

function getServiceWithId(countryCode, id)

Requests service with provided id from the regional server for the provided countryCode

function postService(countryCode, ssr, token)

Post a service to Spatial Services Discovery server of provided region

function postSsrFile(countryCode, file, token)

Post the content of a .json file to Spatial Services Discovery server of provided region

function putService(countryCode, ssr, id, token)

Send an edited SSR record to the server

function validateSsr(ssr, fileName = '')

Validate the provided Spatial Services Record against the SSR json schema

function searchServicesForProducer(countryCode, token)

Request all services for the current tenant in the provided region

function deleteWithId(countryCode, id, token)

Delete the record with the provided id and region

Authentication

The spatial discovery services use auth0 for authentication. It uses the spa SDK from auth0. To use the authentication, create an .env file at the root of your project and add these values:

AUTH0_SSD_DOMAIN = 
AUTH0_SSD_CLIENTID = 
AUTH0_SSD_AUDIENCE = 
AUTH0_SSD_SCOPE =

We use in rollup replace to replace the placeholders with the specific values during packaging of the browser app.

function init()

Instantiate and initialize the auth0 object, used for login/logout and api access

function login()
function logout()

getToken()

Returns the auth0 access token

authenticated

true when client is logged in

user

The user record from auth0

More information about the discovery services used can be found here:

Spatial Service Discovery

Spatial Content Discovery

Admin Sample, uses this module