@trailstash/ultra 3.2.2 → 3.3.0

package/build-examples-docs.js

@@ -23,9 +23,9 @@ ${description}
 ${queryContent}
 \`\`\`
 <br>
-<a target="_blank" href="/#map&${params.toString()}">View Map on Overpass Ultra</a>
+<a target="_blank" href="/#map&${params.toString()}">View Map on Ultra</a>
 <br>
-<a target="_blank" href="/#${params.toString()}">Edit Query on Overpass Ultra</a>`;
+<a target="_blank" href="/#${params.toString()}">Edit Query on Ultra</a>`;
   if (dir.startsWith("MapLibre-Examples"))
     html += `<br>
 <a target="_blank" href="https://maplibre.org/maplibre-gl-js/docs/examples/${file.replace(".ultra", "")}/">View MapLibre Example</a>

package/cli/build.js

@@ -11,9 +11,9 @@ const engine = new Liquid();
 export const getHTMLContext = async (configFile) => {
   const config = await import(configFile);
   const {
-    settings: { title, description, url, mastodon },
+    settings: { title, icon, description, url, mastodon },
   } = config.modes[config.defaultMode];
-  return { title, description, url, mastodon };
+  return { title, icon, description, url, mastodon };
 };
 
 export const buildConfigFromQuery = async (config, query) => {

package/components/ultra-ide.js

@@ -95,7 +95,7 @@ export class UltraIDE extends HTMLElement {
     "options",
     "controls",
     "mapStyle",
-    "extraQueryProviders",
+    "queryProviders",
     "persistState",
   ];
   static props = ["settings", "query", "styles", "title", "icon", "help"];

package/components/ultra-map.js

@@ -5,7 +5,6 @@ import { setQueryBounds } from "../lib/bounds.js";
 import { setBaseStyle } from "../lib/style.js";
 import { parseSettings } from "../lib/settings.js";
 import queryProviders from "../lib/queryProviders/index.js";
-import AutoProvider from "../lib/queryProviders/auto.js";
 import {
   hasHash,
   getOptionsFromQueryParams,
@@ -48,7 +47,7 @@ export class UltraMap extends HTMLElement {
     options: {},
     controls: [],
     fitBounds: false,
-    extraQueryProviders: {},
+    queryProviders,
     persistState: false,
   };
 
@@ -70,10 +69,10 @@ export class UltraMap extends HTMLElement {
 
   persistState = UltraMap.defaults.persistState;
 
-  extraQueryProviders = UltraMap.defaults.extraQueryProviders;
+  queryProviders = UltraMap.defaults.queryProviders;
 
   static CONFIG_SETTINGS = [
-    "extraQueryProviders",
+    "queryProviders",
     "loadSettingsFromQueryParams",
     "persistState",
   ];
@@ -192,7 +191,8 @@ export class UltraMap extends HTMLElement {
         this.#fitBounds &&
         (!this.options.hash || !hadHash) &&
         !this.options.bounds &&
-        (this.options.zoom === undefined || !this.options.center)
+        this.options.zoom === undefined &&
+        !this.options.center
       ) {
         if (
           this.#cachedSource?.type === "geojson" &&
@@ -241,7 +241,7 @@ export class UltraMap extends HTMLElement {
       controller = new AbortController();
     }
 
-    const queryProvider = this.#queryProviders[this.type];
+    const queryProvider = this.queryProviders[this.type];
     if (!queryProvider) {
       throw new Error(`invalid query provider: ${this.type}`);
     }
@@ -266,25 +266,11 @@ export class UltraMap extends HTMLElement {
     return this.#cachedSource.data;
   }
 
-  get #queryProviders() {
-    if (!this.#autoProvider) {
-      this.#autoProvider = new AutoProvider({
-        ...queryProviders,
-        ...this.extraQueryProviders,
-      });
-    }
-    return {
-      auto: this.#autoProvider,
-      ...queryProviders,
-      ...this.extraQueryProviders,
-    };
-  }
-
   get #fitBounds() {
     if (this.fitBounds) {
       return this.fitBounds;
     }
-    const queryProvider = this.#queryProviders[this.type];
+    const queryProvider = this.queryProviders[this.type];
     if (queryProvider && queryProvider.fitBounds) {
       return queryProvider.fitBounds;
     }
@@ -294,14 +280,14 @@ export class UltraMap extends HTMLElement {
     if (this.popupTemplate) {
       return this.popupTemplate;
     }
-    const queryProvider = this.#queryProviders[this.type];
+    const queryProvider = this.queryProviders[this.type];
     if (queryProvider && queryProvider.popupTemplate) {
       return queryProvider.popupTemplate;
     }
     return this.popupTemplate;
   }
   get #popupContextBuilder() {
-    const queryProvider = this.#queryProviders[this.type];
+    const queryProvider = this.queryProviders[this.type];
     if (queryProvider && queryProvider.popupContextBuilder) {
       return queryProvider.popupContextBuilder;
     }

package/docs/yaml.md

@@ -42,26 +42,89 @@ popupTemplate: "{{type}} {{id}} - {{tags.name}}"
 
 Specify the type of source in the query.
 
-**Default:** `overpass`
+**Default:** `auto`
+
+### `auto`
+Automatically detects and chooses the right query provider out of the following:
+* `overpass`
+* `osmWebsite`
+* `osmWiki`
+* `geojson`
+* `osmxml`
+* `osmjson`
+* `kml`
+* `gpx`
+* `tcx`
+
+See each provider for how it is auto-detected
 
 ### `overpass`
 An [Overpass QL](https://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL) query. Results
 converted into a [GeoJSON source](https://maplibre.org/maplibre-style-spec/sources/#geojson) with
 [`osmtogeojson`](https://github.com/tyrasd/osmtogeojson).
 
+Detected if:
+ * Parses as XML and the top level tag is `osm-script`
+ * Matches one of the regexes defined [here](https://gitlab.com/trailstash/ultra/-/blob/main/lib/queryProviders/overpass.js#L11-34)
+
+### `osmWebsite`
+Parses a URL to an node/way/relation on `osm.org` and fetches that element using an Overpass query
+using `out geom;`
+
+Detected if:
+ * A URL on osm.org starting with node/way/relation
+
+### `osmWiki`
+Perform an Overpass query using `nwr` and `out geom;` for an OSM wiki URL starting with `Tag:` or
+`Key:`
+
+Detected if:
+ * A URL to the OSM wiki starting with `Tag:` or `Key:`
+
 ### `osmxml`
 An [OSM XML](https://wiki.openstreetmap.org/wiki/OSM_XML) document or a URL to one. Converted into
 a [GeoJSON source](https://maplibre.org/maplibre-style-spec/sources/#geojson) with
 [`osmtogeojson`](https://github.com/tyrasd/osmtogeojson).
 
+Detected if:
+ * Parses as XML and the top level tag is `osm`
+ * Parses as a URL and the path matches that of an `node/:id`, `way/:id/full`, or
+   `relation/:id/full` OSM API route
+
 ### `osmjson`
 An [OSM JSON](https://wiki.openstreetmap.org/wiki/OSM_JSON) document or a URL to one. Converted
 into a [GeoJSON source](https://maplibre.org/maplibre-style-spec/sources/#geojson) with
 [`osmtogeojson`](https://github.com/tyrasd/osmtogeojson).
 
+Detected if:
+ * Parses as JSON and contains a `version` key containing the value `0.6` at the top level.
+ * Parses as a URL and the path matches that of an `node/:id`, `way/:id/full`, or
+   `relation/:id/full` OSM API route
+
 ### `geojson`
 A JSON-encoded GeoJSON object or a URL to a GeoJSON file.
 
+Detected if:
+ * Parses as JSON and contains a `type` with a valid GeoJSON type.
+
+### `kml`
+A KML file or URL to a KML file.
+
+Detected if
+ * Parses as XML and contains a top level `kml` tag
+
+### `gpx`
+A GPX file or URL to a GPX file.
+
+Detected if
+ * Parses as XML and contains a top level `gpx` tag
+
+### `tcx`
+A TCX file or URL to a TCX file.
+
+Detected if
+ * Parses as XML and contains a top level `tcx` tag
+
 ### `raster`
 A line delimited list of [tile URLs](https://maplibre.org/maplibre-style-spec/sources/#tiles_1) for
 a [raster source](https://maplibre.org/maplibre-style-spec/sources/#raster) or a [TileJSON

package/index.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <link rel="icon" href="./logo.png" />
+    <link rel="icon" href="{{ icon | default: "./logo.png" }}"/>
     {% if mastodon %}
     <link rel="me" href="{{ mastodon }}" />
     {% endif %}

package/lib/queryParams.js

@@ -42,16 +42,16 @@ const fetchURL = async (url) => {
 };
 
 export const hasHash = (hashName) => {
-  let hash = window.location.hash.slice(1)
+  let hash = window.location.hash.slice(1);
   if (hashName) {
     const params = new URLSearchParams(hash);
     hash = params.get(hashName);
   }
   if (!hash) {
-    return false
+    return false;
   }
   const loc = hash.split("/");
-  return loc.length >= 3 && !loc.some(v => isNaN(v));
+  return loc.length >= 3 && !loc.some((v) => isNaN(v));
 };
 
 export const getQueryFromQueryParams = () => {

package/lib/queryProviders/index.js

@@ -1,3 +1,4 @@
+import AutoProvider from "./auto.js";
 import overpass, { osmWebsite, osmWiki } from "./overpass.js";
 import geojson from "./geojson.js";
 import raster from "./raster.js";
@@ -7,7 +8,7 @@ import kml from "./kml.js";
 import gpx from "./gpx.js";
 import tcx from "./tcx.js";
 
-export default {
+export const all = {
   overpass,
   osmWebsite,
   osmWiki,
@@ -20,3 +21,5 @@ export default {
   raster,
   vector,
 };
+
+export default { auto: new AutoProvider(all), ...all };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.2.2",
+  "version": "3.3.0",
   "description": "A web based tool for making MapLibre GL maps with data from sources such as Overpass, GeoJSON, GPX, KML, TCX, etc",
   "main": "index.js",
   "scripts": {