Support separate urls for OAuth handshake and OSM API usage

(closes #123) see also: openstreetmap/operations#951 facebook/Rapid#1130 openstreetmap/iD@c4d1390
osmlab · Oct 24, 2023 · b42ca40 · b42ca40
1 parent cce3ba0
commit b42ca40
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -160,7 +160,8 @@ var redirectPath = window.location.origin + window.location.pathname;
 Additional options are:
 
  - `access_token` - Can pre-authorize with an OAuth2 bearer token if you have one
- - `url` - A base url (default: "https://www.openstreetmap.org")
+ - `apiUrl` - A base url for the OSM API (default: "https://api.openstreetmap.org")
+ - `url` - A base url for the OAuth2 handshake (default: "https://www.openstreetmap.org")
  - `auto` - If `true`, attempt to authenticate automatically when calling `.xhr()` or `fetch()` (default: `false`)
  - `singlepage` - If `true`, use page redirection instead of a popup (default: `false`)
  - `loading` - Function called when auth-related xhr calls start
@@ -269,4 +270,4 @@ Options  (getter / setter)<br/>
 <br/>
 Param:  `val?`   Object containing options<br/>
 Return:  current `options` (if getting), or `self` (if setting)<br/>
-<br/>
+<br/>
diff --git a/dist/osm-auth.cjs b/dist/osm-auth.cjs
@@ -235,7 +235,7 @@ function osmAuth(o) {
       }
     }
     function _doXHR() {
-      var url = options.prefix !== false ? o.url + options.path : options.path;
+      var url = options.prefix !== false ? o.apiUrl + options.path : options.path;
       return oauth.rawxhr(
         options.method,
         url,
@@ -289,6 +289,7 @@ function osmAuth(o) {
     if (!arguments.length)
       return o;
     o = val;
+    o.apiUrl = o.apiUrl || "https://api.openstreetmap.org";
     o.url = o.url || "https://www.openstreetmap.org";
     o.auto = o.auto || false;
     o.singlepage = o.singlepage || false;

diff --git a/dist/osm-auth.cjs.map b/dist/osm-auth.cjs.map
diff --git a/dist/osm-auth.iife.js b/dist/osm-auth.iife.js
diff --git a/dist/osm-auth.iife.js.map b/dist/osm-auth.iife.js.map
diff --git a/src/osm-auth.mjs b/src/osm-auth.mjs
@@ -362,7 +362,7 @@ export function osmAuth(o) {
     }
 
     function _doXHR() {
-      var url = options.prefix !== false ? (o.url + options.path) : options.path;
+      var url = options.prefix !== false ? (o.apiUrl + options.path) : options.path;
       return oauth.rawxhr(
         options.method,
         url,
@@ -455,6 +455,7 @@ export function osmAuth(o) {
     if (!arguments.length) return o;
 
     o = val;
+    o.apiUrl = o.apiUrl || 'https://api.openstreetmap.org';
     o.url = o.url || 'https://www.openstreetmap.org';
     o.auto = o.auto || false;
     o.singlepage = o.singlepage || false;
@@ -621,4 +622,4 @@ function base64(buffer) {
     .replace(/\//g, '_')
     .replace(/\+/g, '-')
     .replace(/[=]/g, '');
-}
+}
diff --git a/test/index.test.js b/test/index.test.js
@@ -11,6 +11,7 @@ test('osmauth', t => {
       localStorage.clear();
       const keys = {
         url: 'https://www.openstreetmap.org',
+        apiUrl: 'https://api.openstreetmap.org',
         client_id: 'JWXSAzNp64sIRMStTnkhMRaMxSR964V4sFgn3KUZNTA',
         client_secret: '6umOXfkZqH5CVUtv6iDqN7k8o7mKbQvTrHvbDQH36hs',
         redirect_uri: 'http://127.0.0.1:8080/land.html',
@@ -32,6 +33,7 @@ test('osmauth', t => {
       localStorage.clear();
       const auth = osmAuth({
         url: 'https://www.openstreetmap.org',
+        apiUrl: 'https://api.openstreetmap.org',
         client_id: 'JWXSAzNp64sIRMStTnkhMRaMxSR964V4sFgn3KUZNTA',
         redirect_uri: 'http://127.0.0.1:8080/land.html',
         scope: 'read_prefs'
@@ -44,6 +46,7 @@ test('osmauth', t => {
       localStorage.clear();
       const auth = osmAuth({
         url: 'https://www.openstreetmap.org',
+        apiUrl: 'https://api.openstreetmap.org',
         client_id: 'JWXSAzNp64sIRMStTnkhMRaMxSR964V4sFgn3KUZNTA',
         redirect_uri: 'http://127.0.0.1:8080/land.html',
         scope: 'read_prefs',