@trailstash/ultra 3.4.2 → 3.4.4

package/README.md

@@ -3,8 +3,8 @@
 Ultra (née Overpass Ultra) is a web-application made to simplify making maps with [MapLibre GL
 JS](https://maplibre.org).
 
-- Stable version - [overpass-ultra.us](https://overpass-ultra.us) <small>([config](https://gitlab.com/trailstash/overpass-ultra/-/blob/main/config.js))</small>
-- Latest version - [ultra.trailsta.sh](https://ultra.trailsta.sh) <small>([config](https://gitlab.com/trailstash/ultra/-/blob/main/config.js))</small>
+- Stable version - [overpass-ultra.us](https://overpass-ultra.us) <small>([config](https://gitlab.com/trailstash/overpass-ultra/-/blob/main/config.mjs))</small>
+- Latest version - [ultra.trailsta.sh](https://ultra.trailsta.sh) <small>([config](https://gitlab.com/trailstash/ultra/-/blob/main/config.mjs))</small>
 - OHM version - [ohm.overpass-ultra.us](https://ohm.overpass-ultra.us) <small>([config](https://gitlab.com/trailstash/ohm-ultra/-/blob/main/config.js))</small>
 
 ## Documentation

package/cli/build.js

@@ -63,7 +63,7 @@ export default class Build extends Command {
     config: Flags.string({
       char: "c",
       description: "configuration to use",
-      default: path.join(process.cwd(), "/config.js"),
+      default: path.join(process.cwd(), "/config.mjs"),
     }),
   };
   static args = {
@@ -82,9 +82,9 @@ export default class Build extends Command {
 
     if (!fs.existsSync(config)) {
       console.error(
-        `"${config}" not found, using ${path.join(ultraRoot, "config.js")}`,
+        `"${config}" not found, using ${path.join(ultraRoot, "config.mjs")}`,
       );
-      config = path.join(ultraRoot, "config.js");
+      config = path.join(ultraRoot, "config.mjs");
     }
 
     if (query) {

package/cli/serve.js

@@ -43,9 +43,9 @@ export default class Serve extends Command {
 
     if (!fs.existsSync(config)) {
       console.error(
-        `"${config}" not found, using ${path.join(ultraRoot, "config.js")}`,
+        `"${config}" not found, using ${path.join(ultraRoot, "config.mjs")}`,
       );
-      config = path.join(ultraRoot, "config.js");
+      config = path.join(ultraRoot, "config.mjs");
     }
 
     if (query) {

package/components/help-modal.js

@@ -32,18 +32,6 @@ Full documentation for Ultra is available at ${window.location.origin}/docs
 Various aspects of Ultra, such as styling, can be
 configured via [YAML front-matter](/docs/yaml).
 
-## Query Bounds
-
-The following shortcuts are available to parameterize your queries:
-
-| shortcut | description |
-| -------- | ----------- |
-| \`{{bbox}}\` | The map's bounds in the format expected by [https://overpass-api.de](Overpass) |
-| \`{{south}}\` | The Southern Latitude of the map's bounds |
-| \`{{north}}\` | The Northern Latitude of the map's bounds |
-| \`{{east}}\` | The Eastern Longitude of the map's bounds |
-| \`{{west}}\` | The Western Longitude of the map's bounds |
-
 ## Styling
 
 Ultra supports styling using an extended version of the the
@@ -51,6 +39,15 @@ Ultra supports styling using an extended version of the the
 
 See the [Styling](/docs/style) section for more information.
 
+## Overpass Queries
+
+The Overpass API allows you to query for OSM data by your own search criteria. For this purpose, it
+has a specifically crafted query language: [Overpass
+QL](https://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL)
+
+In addition to regular Overpass API queries one can use \`{{bbox}}\` to specify the bounding box
+coordinates of the current map view.
+
 ## About
 
 Ultra is built by Daniel Schep.
@@ -96,7 +93,7 @@ export class HelpModal extends HTMLElement {
     let stylesHTML = "";
     if (this.styles.length > 0) {
       stylesHTML = `<div><h4>Style & Tile Providers</h4><ul>`;
-      const styles = new Set(this.styles.map(style => style[2]));
+      const styles = new Set(this.styles.map((style) => style[2]));
       for (const style of styles) {
         stylesHTML += `<li>${style}</li>`;
       }
@@ -120,7 +117,7 @@ export class HelpModal extends HTMLElement {
               <li>
                 Map powered by
                 <a target="_blank" href="https://github.com/maplibre/maplibre-gl-js/"
-                  >MapLibre GL JS</a
+                  >maplibre-gl</a
                 > <code>${maplibreVersion}</code>
               </li>
               <li>

package/docs/index.md

@@ -16,45 +16,55 @@ It can easily visualize the following file/query types:
  * [OSM XML](https://wiki.openstreetmap.org/wiki/OSM_XML)
  * [OSM JSON](https://wiki.openstreetmap.org/wiki/OSM_JSON)
 
+## Getting Started
+All Ultra maps defined by a document containing an optional configuration and optional query. For
+example, to query bicycle repair stations using the [Overpass API](https://overpass-api.de), you
+can make a document containing an OverpassQL query:
+
+```
+node[amenity=bicycle_repair_station]({{bbox}});
+out;
+```
+
+Or to place a red marker at Eiffel Tower using a GeoJSON document as the query:
+```
+---
+style:
+  layers:
+    - type: symbol
+      icon-image: maki:marker
+      icon-color: red
+      icon-anchor: bottom
+---
+{
+  "type": "FeatureCollection",
+  "features": [
+    {
+      "type": "Feature",
+      "properties": {},
+      "geometry": {
+        "coordinates": [
+          2.2945119627238455,
+          48.85826635779679
+        ],
+        "type": "Point"
+      }
+    }
+  ]
+}
+```
+
+For more examples, see the [Examples](./Examples) and [MapLibre Examples](./MapLibre Examples)
+sections.
+
 ## Configuration
 
 Various aspects of Ultra, such as styling, can be
 configured via [YAML front-matter](./yaml.md).
 
-## Query Bounds
-
-The following shortcuts are available to parameterize your queries:
-
-| shortcut | description |
-| -------- | ----------- |
-| `{{bbox}}` | The map's bounds in the format expected by [Overpass](https://overpass-api.de) |
-| `{{south}}` | The Southern Latitude of the map's bounds |
-| `{{north}}` | The Northern Latitude of the map's bounds |
-| `{{east}}` | The Eastern Longitude of the map's bounds |
-| `{{west}}` | The Western Longitude of the map's bounds |
-
 ## Styling
 
 Ultra supports styling using an extended version of the the
 [MapLibre Style Spec](https://maplibre.org/maplibre-style-spec/).
 
 See the [Styling](./style.md) section for more information.
-
-## About
-
-Ultra is built by Daniel Schep.
-
-You can contact me on [Mastodon](https://mapstodon.space/@trailstash).
-
-## Feedback, Bug Reports, Feature Requests
-
-While Ultra has been in development for a while, it should still be considered
-experimental.
-
-If you would like to report a bug or provide other feedback, please do so in the project's
-[Issue Tracker](https://gitlab.com/trailstash/ultra/-/issues).
-
-## Source Code</h4>
-
-The [source code](https://gitlab.com/trailstash/ultra) of this application is released under the
-[MIT license](https://gitlab.com/trailstash/ultra/-/blob/master/LICENSE).

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.4.2",
+  "version": "3.4.4",
   "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": {