πΊοΈπ Javascript/Typescript wrapper around the OpenStreetMap API
MIT License
πΊοΈπ Javascript/Typescript wrapper around the OpenStreetMap API.
Benefits:
client_secret
npm install osm-api
const OSM = require("osm-api");
// or
import * as OSM from "osm-api";
// you can call methods that don't require authentication
await OSM.getFeature("way", 23906749);
// Once you login, you can call methods that require authentication.
// See the section below about authentication.
await OSM.createChangesetComment(114733070, "Thanks for your edit!");
If you don't use a bundler, you can also include the module using a <script>
tag:
<script src="https://unpkg.com/osm-api@2"></script>
<script>
OSM.getFeature("way", 23906749);
OSM.login({ ... });
...
</script>
All methods return promises. Examples requests and responses are available for all methods:
π means the method requires authentication
deleteMessage()
getMessage()
listMessages()
sendMessage()
updateMessageReadStatus()
getPreferences()
updatePreferences()
deletePreferences()
login
logout
isLoggedIn
getAuthToken()
authReady
getPermissions()
When used in the browser, this library lets you authenticate to OSM using OAuth 2. This requires either:
If using a popup, you should create a separate landing page, such as land.html
. This html file should contain the following code:
π‘ If you don't want to create a separate page, you can set the redirect URL to your app's main page, as long as you include this HTML snippet.
<script>
if (window.opener) {
window.opener.authComplete(location.href);
window.close();
}
</script>
To login, or check whether the user is logged in, use the following code:
const OSM = require("osm-api");
OSM.login({
mode: "popup",
clientId: ".......",
redirectUrl: "https://example.com/land.html",
})
.then(() => {
console.log("User is now logged in!");
})
.catch(() => {
console.log("User cancelled the login, or there was an error");
});
// you can check if a user is logged in using
OSM.isLoggedIn();
// and you can get the access_token using
OSM.getAuthToken();
If you use the redirect method, you don't need a separate landing page.
const OSM = require("osm-api");
// when you call this function, you will be immediately redirected to openstreetmap.org
OSM.login({
mode: "redirect",
clientId: ".......",
redirectUrl: "https://example.com/land.html",
});
const OSM = require("osm-api");
// If you login using the redirect method, you need to await
// this promise before you can call `isLoggedIn` or `getAuthToken`.
await OSM.authReady;
// you can check if a user is logged in using
OSM.isLoggedIn();
// and you can get the access_token using
OSM.getAuthToken();
In NodeJS, if you want to use a method that requires authentication, call the configure()
function first:
const OSM = require("osm-api");
OSM.configure({ bearerToken: "..." });
// or
OSM.configure({ basicAuth: { username: "...", password: "..." } });
// now you can call methods that require authentication.
// Example:
await OSM.createChangesetComment(114733070, "Thanks for your edit!");
This library offers several advantages over osm-request:
While osm-request has been revived, osm-api-js was created when osm-request was abandoned and lacked OAuth 2 support.