Xyz Save

v4.8.3

Open source presentation, controller, domain and service layers for cloud native spatial data and application interfaces.

XYZ

The pattern for the Node.js domain and service layer are that of a RESTful API which provides secure gateways for spatial data sources and 3rd party service providers. The domain layer handles API routing, rewrites, and ressource caching. The service layer manages authentication and transaction script. URL parameter (and payloads) from the application control layer are assigned to query templates and passed to the data source layer. The response being parsed and returned to the presentation layer. The Node.js application layers may be served by an Express web server or deployed as cloud native serverless functions.

MAPP

Application control and presentation layers are provided as ES6 javscript libraries. MAPP utilizes the Openlayers map engine for mapviews and provides an interface to the XYZ API. The library abstracts away the complexities of handling spatial data objects such as layers and locations.

MAPP.UI contains utilities to build engaging user interfaces around mapviews. The application views can be dashboards made up of multiple data views such as maps, tables, lists, or graphs.

Documentation

Please refer to the wiki pages for detailed interface references.

Version History

v1 was build with Leaflet as the map render for the client library.

The Mapp library changed the map render to Openlayers in v2.

The XYZ API was rebuild to run as serverless functions in v3.

v4 is a complete rewrite of the client libraries. All user interface utilities have been taken out of the mapp library and have been compiled as mapp.ui library. Both libraries are now bundled with esbuild.

The mapp library is now able to instantiate multiple mapviews.

Polymorphism is applied to extend or modify object types and methods through plugins without the need to fork the repository.

Dynamic module imports reduce the need to bundle 3rd party libraries such as Tabulator and Chart.js.

XYZ Dependencies

Node.js v18+

bcrypt - A library to help you hash passwords.

jsonwebtoken - A Node implementation of JSON Web Token.

Node-Postgres - PostgreSQL client for Node.

nodemailer - Send e-mails with Node – easy as cake!

aws-sdk - Several modules are required in order to access resources on cloudfront or S3.

simple-statistics - A JavaScript implementation of descriptive, regression, and inference statistics.

Development dependencies

Following development dependencies are required to build the library and run a local instance of the XYZ host.

Express - Fast, unopinionated, minimalist web framework for Node.

cookie-parser - Parse cookie header for express.js.

dotenv - Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env.

esbuild - A JavaScript bundler and minifier.

µhtml - A micro HTML/SVG render which is bundled as utils into the MAPP library.

eslint - A tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.

Mapp Dependencies

Openlayers - High-performance web mapping engine.

License

Free use of the code in this repository is allowed through a MIT license.

BrowserStack

BrowserStack supports this OpenSource project and provides us with valuable tools to test the Mapp library on different client platforms.