OverpassQL Loader

This Webpack loader allows you to pull in OverpassQL files as strings, providing seamless integration of OpenStreetMap data into your application.

Not only does it allow you to directly load OverpassQL scripts as part of your Webpack build process, but it also optionally caches the responses from an Overpass API server to speed up your production application.

Features

Implemented in TypeScript for strong type safety.
Load OverpassQL scripts as strings into your JavaScript or TypeScript application.
Optionally cache responses from an Overpass API server.

Installation

You can install the loader using npm, yarn, or your preferred JavaScript package management program.

yarn add --dev overpassql-loader

npm install --save-dev overpassql-loader

Usage

Add overpassql-loader to your Webpack configuration:

import type { Configuration, RuleSetUse } from 'webpack';
import type { PropertiesFilter } from 'overpassql-loader';

const IS_DEV: boolean = (process.env.NODE_ENV === 'development');

const propertiesFilter: PropertiesFilter = (properties) => ({
  return (Object.keys(properties)
    .filter(tag => /addr:.*/i.test(tag))
    .reduce((filtered, tag) => {
      filtered[tag] = properties[tag];
      return filtered;
    }, {}));
});

const useOverpassql: RuleSetUse = {
  test: /\.overpass(ql)?$/,
  options: {
    // minify the query
    stripWhitespace: !IS_DEV,
    stripComments: !IS_DEV,

    // cache API response
    cacheGeoJSON: !IS_DEV,

    // remove tags we're not interested in
    keepProperties: false,
    propertiesFilter
  }
}

export const config: Configuration = {
  module: {
    rules: [useOverpassql]
  }
}

Use the import in your project:

import { overpassJson } from 'overpass-ts';
import osmtogeojson from 'osmtogeojson';
import query from './my-query.overpassql';

const endpoint: string = 'https://overpass-api.de/api/interpreter';

console.log(query); // print the query to console
overpassJson(query, { endpoint }).then((osmdata) => {
  const geoJSON = osmtogeojson(osmdata);

  // work with the GeoJSON or OSM response
  // e.g., integrate with Leaflet.js GeoJSON layers
});

Contributing

General advice

The following procedure for contributing changes is recommended:

Branch to fix/[issue or description], feature/[issue or description], ...
Implement your changes and commit
Open a pull request

Of course, you're welcome to use any reasonable workflow that best suits your style. After all, I committed to unprotected main throughout this project.

Please add any of the following strings to your commit message if the commit does not modify any code (e.g., documentation work):

[skip ci], [ci skip], [no ci], [skip actions], [actions skip]

See: GitHub documentation, "skipping workflow runs"

Versioning

To bump versions:

yarn version --patch
yarn version --minor
yarn version --major

Licensing

Given this project is licensed under the MIT License, please be mindful that your contributions will fall under the same licensing scheme.

Related Projects & Dependencies

The following projects are core to the function of OverpassQL Loader. They are worth checking out. The authors have my thanks. :-)

overpass-ts

promise-based overpass api client in typescript

osmtogeojson

Converts OSM data to GeoJSON.

License

This project is licensed under the MIT License. See LICENSE for more information.