stac-validator v0.3.1

NodeJS Stac Validator

Validates a spatial temporal catalog asset based on the specs laid out by Radiant Earth.

Usage

validateStac

Validate from URL validates STAC from a remote source.

validateFromObject

Validates a STAC asset from user-provided parsed object. Will not check any deeper.

Intended Usage

Modules

This will be subject to change until this is released on NPM

    const { validateStac, validateFromObject } = require('@sparkgeo/stac-validator')


    const type = 'catalog' // or 'item' or 'collection'
    const url = 'https//...'

    const responseFromUrl = validateStac({url, type})

    (...)

    const catalog = { ... } // stac catalog
    const collection = { ... } // stac collection
    const item = { ... } // stac item

    const responseFromJsonItem = validateFromObject({asset: item, type: 'item'})
    const responseFromJsonCollection = validateFromObject({asset: collection, type: 'collection'})
    const responseFromJsonCatalog = validateFromObject({asset: catalog, type: 'catalog'})

Example Responses

Success

A successful response returns an object with a success boolean, as well as a verified_files, which provides a series of responses.

  {
    success: true,
    responses: [
      {
        valid: true,
        location: '<location of file>',
        errors: []
      }, (...)
    ]
  }

Failure

A failure response shares the success and verified_files attributes. In addition, it adds a new attribute called errors. The errors object is flat, meaning that there should be no nester arrays of objects present.

The errors object is subject to change until the first stable release, v0.7.0.

  {
    success: false,
    responses: [
      {
        valid: false,
        location: '<location of file>',
        errors: [
          {
            keyword: '',
            message: '',
          }
        ]
      }, (...)
    ]
  }

TODO's

the following is the progress of this progress. Because, at this point, it is a one-man show, I'm documenting everything here.

• Initial Building
• Mock integration tests from requirements
• Set up and document entry point
• Use Recursion to obtain an entire STAC stack from a single entry point
• Enforce rigidity of the context object.
• Example of push-polling
• Remove webpack for production build
• Add CI/CD Support as part of release to master.

The Context Object

The context object allows for real-time operations such as streaming. This is in-progress.

Sample Catalog

https://cbers-stac.s3.amazonaws.com/CBERS4/catalog.json

Internal Testing

To test this library internally, open the node REPL from the base directory of this repository

 $ node

From within, you will be able to access the library with the following commands:

     const { validateStac, validateFromObject } = require('./src/index.js')
     let url = 'https://cbers-stac.s3.amazonaws.com/CBERS4/catalog.json'
     let type = 'catalog'
     let version = '0.5.2'
     let useRecursion = true


     validateStac({url, type, version, useRecursion})
       .then(result => {
         console.log('Response -> ', response)
         })
       .catch(e => {
         console.log('Error -> ', e)
       })

     // Check the response after