Navel Pondering Mantra
Learn how companies like Phone2Action are using npm in their front-end developmentJoin the conversation »

hyperdb-osm-server

3.0.1 • Public • Published

hyperdb-osm-server

Peer-to-peer OpenStreetMap API v0.6 Server

An implementation of the OpenStreetMap API v0.6 for hyperdb-osm, a peer-to-peer OSM database. It runs on node.js or, if you are creative, also in the browser. Data is stored in a LevelUP database. There is no need to set up a database, everything you need to get started is available as a single package that you can install from npm.

hyperdb-osm-server is tested and working with iD Editor - it appears as identical to the standard OSM API. It should theoretically work in the future with other editors such as JOSM but hyperdb-osm-server needs to use at least 64-bit ids to avoid collisions, and JOSM currently still uses 32-bit integers for some ids, such as changeset ids and version numbers.

hyperdb-osm-server is designed to run locally on each client. Synchronize data between clients by replicating the hyperdb-osm database. You can implement replication over wifi, bluetooth or via USB thumb drives (examples coming soon).

This module is for developers who want to build their own OSM tools. For users who want a one-click install of hyperdb-osm-server with iD Editor see Mapeo Desktop.

Table of Contents

Install

You will need to first install node.js

npm install hyperdb-osm-server

Routes

hyperdb-osm-server currently implements the following routes from the OSM API v0.6:

  • GET /api(/0.6)?/capabilities
  • GET /api/0.6/map
  • PUT /api/0.6/changeset/create
  • POST /api/0.6/changeset/:id/upload
  • PUT /api/0.6/changeset/:id/close
  • GET /api/0.6/map
  • GET /api/0.6/:type(nodes|ways|relations)?:ktype(nodes|ways|relations)=:ids
  • GET /api/0.6/:type(node|way|relation)/:id
  • GET /api/0.6/:type(node|way|relation)/:id/:version
  • GET /api/0.6/:type(node|way|relation)/:id
  • GET /api/0.6/:type(node|way|relation)/:id/history
  • GET /api/0.6/:type(way|relation)/:id/full

API

var osmrouter = require('hyperdb-osm-server')

var router = osmrouter(osm)

Create a new OpenStreetMap router given an hyperdb-osm handle osm.

var m = router.handle(req, res)

Match the req.method and req.url and dispatch m.fn(m, req, res) and return the match object if there is a match, or else null.

var m = router.match(method, url)

Return a match object m if method and url can be handled by the server. Used internally by router.handle(). The match object for router.match('GET', '/api/0.6/node/1234') would be:

{
  params: {
    type: 'node',
    id: '1234',
  },
  splats: [],
  route: '/:type(node|way|relation)/:id',
  fn: [Function],
  next: [Function]
}

API Example

var hyperosm = require('hyperdb-osm')
var hyperdb = require('hyperdb')
var ram = require('random-access-memory')
var memdb = require('memdb')
var Geo = require('grid-point-store')
var osmRouter = require('hyperdb-osm-server')
 
var osm = hyperosm({
  db: hyperdb(ram, { valueEncoding: 'json' })),
  index: memdb(),
  pointstore: Geo(memdb())
})
 
var router = osmRouter(osm)
 
var http = require('http')
var server = http.createServer(function (req, res) {
  if (router.handle(req, res)) {}
  else {
    res.statusCode = 404
    res.end('not found\n')
  }
})
server.listen(5000)

Use as Express middleware

var hyperosm = require('hyperdb-osm')
var hyperdb = require('hyperdb')
var ram = require('random-access-memory')
var memdb = require('memdb')
var Geo = require('grid-point-store')
var osmRouter = require('hyperdb-osm-server')
var express = require('express')
 
var osm = hyperosm({
  db: hyperdb(ram, { valueEncoding: 'json' })),
  index: memdb(),
  pointstore: Geo(memdb())
})
 
var app = express()
app.use('/api/0.6', osmRouter(osm))
 
app.use(function handleError (err, req, res, next) {
  if (!err) return
  if (!res.headersSent) {
    res.statusCode = err.status || err.statusCode || 500
    res.setHeader('content-type', 'text/plain')
    res.end(err.message + '\n')
  } else {
    next(err)
  }
})
 
app.listen(5000, function () {
  console.log('hyperdb-osm-server listening on port 5000!')
})

REST API

See the documentation for the OSM API v0.6 - hyperdb-osm-server replicates that API as faithfully as possible.

Differences to OSM API v0.6

The main differences to the OSM API v0.6 are related to the peer-to-peer architecture of hyperdb-osm-server. Ids are randomly generated, rather than sequential integers. Version ids are hashes rather than integers. For more details read hyperdb-osm Architecture.

  • If two users edit the same version of an entity (node|way|relation) then two versions will exist in the database. hyperdb-osm-server will not return 409: Conflict if you try to modify or delete an entity which is not the most recent version, it will create a fork instead. Forks can be created if two users edit the same entity whilst disconnected and then later replicate the database.

  • By default hyperdb-osm-server will only return the most recent 'fork', to maintain compatibility with tools that do not understand the concept of forked entities. To see all forks, append ?forks=true to the URL and if multiple forks exist the returned data will include multiple entities with the same id, but different version ids.

  • In changeset uploads (/changeset/:id/upload), the version property of each entity in the changeset can be a comma-separated list of version hashes of the documents that the update will replace. Use this to merge multiple forks into a single fork.

Contributing

If something does not work as it should, please open an Issue. Pull Requests are welcome, please follow JS Standard Style.

License

BSD (c) 2016 Digital Democracy

Install

npm i hyperdb-osm-server

DownloadsWeekly Downloads

2

Version

3.0.1

License

BSD-2-Clause

Unpacked Size

188 kB

Total Files

75

Last publish

Collaborators

  • avatar