@kalisio/geokoder v1.0.2

geokoder

Kalisio geocoder service

geokoder is a service that let you perform forward and reverse geocoding in various sources exposed by a provider. The following providers are currently supported:

• Kano to expose Kano catalog layers as sources,
• NodeGeocoder to expose node-geocoder providers as sources,

• MBTiles to expose layers from MBTiles as sources.

API

/healthcheck (GET)

Checks for the health of the service, returns a json object with the name of the service (geokoder) and it's version number.

/capabilities/:operation (GET)

Returns the list of available geocoding sources according to the target operation, as an array. Available operations are:

• forward for forward geocoding
• reverse for reverse geocoding

/forward?q=searchString&sources=filterPattern (GET)

Performs forward geocoding. Requires at least the q parameter which is the string that'll be searched in the geocoding sources. The query supports an optional sources allowing users to only perform geocoding in matching sources. The source matching is based on minimatch.

The query returns the list of matching features, as an array. Each feature is given a relevance score, and the returned array is sorted based on this value. The service also add to each feature and additional geokoder object containing the following fields:

• source specifies in which source this feature was found
• match indicates which string value was used to compute relevance score
• matchProp indicates which feature property was used to to compute relevance score
• score is the computed relevance score

/reverse?lat=latValue&lon=lonValue&sources=filterPattern (GET)

Performs reverse geocoding at the given point. Requires at least the lat and lon parameters which is the location that'll be searched in the geocoding sources. The query supports an optional sources allowing users to only perform reverse geocoding in matching sources. The source matching is based on minimatch. Some providers could support additional parameters:

• limit the number of maximum items to get in the response
• distance the maximum distance of items to be included in the response (useful for nearby location query not much for point in polygon query)

The query returns the list of matching features, as an array. The service also add to each feature and additional geokoder object containing the following fields:

• source specifies in which source this feature was found

Configuring

local.cjs

By default, geokoder does not expose any sources. You are responsible to write a local.cjs file to declare the different sources you want to expose.

Here is an example file that exposes all the sources from the Kano provider, opendatafrance from the NodeGeocoder provider and api-geo dataset sources from the MBTiles provider:

module.exports = {
  providers: {
    Kano: {},
    NodeGeocoder: {
      opendatafrance: true
    },
    MBTiles: {
      'api-geo': { filepath: '/mnt/data/api-geo-5m.mbtiles', layers: ['communes5m', 'epci5m', 'departements5m', 'regions5m'] }
    }
  }
}

Kano

For now, each layer in the catalog exposing the featureLabel property will be taken into account. This property can be a single string value or an array of strings to target multiple fields.

NodeGeocoder

Each key is a geocoder to instanciate in node-geocoder. If value is false-ish, it won't be instanciated. If you'd like to pass additional options to the geocoder instance then it could be an object containing the options.

NodeGeocoder: {
  opendatafrance: true,
  openstreetmap: false
}

MBtiles

Each key will be a new dataset based on the provided file and exposing some layers as sources such as:

admin-express': { filepath: path.join(__dirname, '../data/mbtiles/admin-express.mbtiles'), layers: ['commune', 'departement'].

NOTE

For performance reason each layer in a dataset should have the same max zoom level, if not two different datasets should be created for now.

i18n

geokoder allows you to declare i18n files which can be used to name the different exposed sources in an understandable way. This description is returned within an i18n object when requestring the capabilities.

An i18n file consists in a javascript file strucuted as below:

module.exports = {
  i18n: {
    fr: {
      Geocoders: {
        'kano:hubeau-hydro-stations': 'Hub\'Eau Hydrométrie',
        'kano:hubeau-piezo-stations': 'Hub\'Eau Piezométrie',
        'kano:icos-stations': 'Réseau ICOS',
        'opendatafrance': 'BAN'
        // ... 
      }
    },
    en: {
      Geocoders: {     
        'kano:hubeau-hydro-stations': 'Hub\'Eau Hydrometry',
        'kano:hubeau-piezo-stations': 'Hub\'Eau Piezometry',        
        'kano:icos-stations': 'ICOS Network',
        'opendatafrance': 'BAN'
        // ...
      }
    }
  }
}

Environment variables

Here are the environment variables you can use to customize the service:

Note

Most of these variables are defined for convenience in order to run the tests.

Building

Manual build

You can build the image with the following command:

docker build -t <your-image-name> .

You can build a sample MBTiles with sources from French API Géo for testing purpose using the provided script after you installed tippecanoe.

Automatic build

This project is configured to use Travis to build and push the image on the Kalisio's Docker Hub. The built image is tagged using the version property in the package.json file.

To enable Travis to do the job, you must define the following variable in the corresponding Travis project:

Deploying

This image is designed to be deployed using the Kargo project.

Testing

To run the tests, use the subcommand test:

yarn test

Contributing

Please read the Contributing file for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the license file for details

Authors

This project is sponsored by