@dataforsyningen/saul 3.2.0 → 3.3.1

package/README.md

@@ -39,6 +39,11 @@ From within `node_modules/@dataforsyningen/saul` you can run the `test` command
 npm run test
 ```
 
+## Publish NPM
+
+Create a new release in Github to publish an updated NPM package.
+Details are available in the "Npm" section of SDFI ITU's wiki.
+
 ## Acknowledgements
 
 SAUL is made available under the MIT license by

package/config.js.example

@@ -1,12 +1,12 @@
 export default {
   
   // STAC TOKEN can be aquired from https://dataforsyningen.dk/
-  API_STAC_TOKEN: "",
-  API_STAC_BASEURL: "https://api.dataforsyningen.dk/skraafoto_api_test/v1.0",
+  API_STAC_TOKEN: "", // Dataforsyningen token
+  API_STAC_BASEURL: "https://api.dataforsyningen.dk/rest/skraafoto_api_test/v1.0",
 
   // DHM URL and auth can be aquired from https://datafordeler.dk/dataoversigt/danmarks-hoejdemodel-dhm/koter/
   API_DHM_WCS_BASEURL: "https://services.datafordeler.dk/DHMNedboer/dhm_wcs/1.0.0/WCS",
   API_DHM_BASEURL: "https://services.datafordeler.dk/DHMTerraen/DHMKoter/1.0.0/GEOREST/HentKoter",
-  API_DHM_USERNAME: "",
-  API_DHM_PASSWORD: ""
+  API_DHM_TOKENA: "", // DHM API service username
+  API_DHM_TOKENB: "" // DHM API service password
 }

package/example.html

@@ -17,7 +17,7 @@
 
     <script type="module">
 
-      // You should add your own config.js with proper tokens, passwords, etc.
+      // You should add your own config.js with proper tokens, etc.
       // Check config.js.example for info on how to set it up 
       import auth from './config.js'
       

package/index.js

@@ -5,7 +5,7 @@ export {
   world2image, // Deprecated. Use getImageXY
   getWorldXYZ,
   getImageXY,
-  getZ, // Deprecated. Use getElevation
+  getZ,
   iterate // Deprecated. Use getWorldXYZ
 } from './modules/saul-core.js'
 

package/modules/api.js

@@ -154,11 +154,11 @@ function post(url, requestbody, token) {
 /** 
  * API method to fetch data from DHM
  * @param {string} query - DHM API query. Find details at https://datafordeler.dk/dataoversigt/danmarks-hoejdemodel-dhm/koter/
- * @param {{API_DHM_BASEURL: string, API_DHM_USERNAME: string, API_DHM_PASSWORD: string}} auth - API autentication data. See ../config.js.example for reference.
+ * @param {{API_DHM_BASEURL: string, API_DHM_TOKENA: string, API_DHM_TOKENB: string}} auth - API autentication data. See ../config.js.example for reference.
  * @returns {object} Response data
  */
 function getDHM(query, auth) {
-  const auth_params = `&username=${auth.API_DHM_USERNAME}&password=${auth.API_DHM_PASSWORD}`
+  const auth_params = `&username=${auth.API_DHM_TOKENA}&password=${auth.API_DHM_TOKENB}`
   return get(encodeURI(auth.API_DHM_BASEURL + query + auth_params))
   .then((data) => data)
 }
@@ -197,7 +197,7 @@ async function consumeGeoTIFF(raw_data) {
 
 /** Fetches a GeoTIFF with elevation data matching the bounding box of a STAC API item (image)
  * @param {object} stac_item - STAC API item from a featureCollection request
- * @param {{API_DHM_WCS_BASEURL: string, API_DHM_USERNAME: string, API_DHM_PASSWORD: string}} auth - API autentication data. See ../config.js.example for reference.
+ * @param {{API_DHM_WCS_BASEURL: string, API_DHM_TOKENA: string, API_DHM_TOKENB: string}} auth - API autentication data. See ../config.js.example for reference.
  * @param {number} [resolution] - Resolution (1 - 0.01). Higher number means more pixels and better precision.
  * @returns {object} GeoTiff data
  */
@@ -210,7 +210,7 @@ function getTerrainGeoTIFF(stac_item, auth, resolution = 0.05) {
   // GET request for DHM WCS data
   let url = auth.API_DHM_WCS_BASEURL
   url += '?SERVICE=WCS&COVERAGE=dhm_terraen&RESPONSE_CRS=epsg:25832&CRS=epsg:25832&FORMAT=GTiff&REQUEST=GetCoverage&VERSION=1.0.0'
-  url += `&username=${ auth.API_DHM_USERNAME }&password=${ auth.API_DHM_PASSWORD }` // TODO: Should be auth stuff
+  url += `&username=${ auth.API_DHM_TOKENA }&password=${ auth.API_DHM_TOKENB }`
   url += `&height=${ height }`
   url += `&width=${ width }`
   url += `&bbox=${ bbox[0]},${ bbox[1]},${ bbox[2]},${ bbox[3]}`

package/modules/saul-core.js

@@ -217,6 +217,7 @@ async function compareZ(options) {
  * @param {array} options.xy - image coordinates
  * @param {object} options.image - STAC API item
  * @param {object} options.terrain - GeoTIFF object from getTerrainGeoTIFF() output
+ * @param {number} precision - Precision in meters for "good enough"
  * @returns {array} Array with world coordinates (indexes 0 and 1) and elevation (index 2). Coordinates are EPSG:25832 format.
  */
 async function getWorldXYZ(options, precision = 0.3) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dataforsyningen/saul",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "This is a collection of stand-alone methods for photogrammetry calculations and API interactions for 'Danske Skråfotos'.",
   "main": "index.js",
   "type": "module",
@@ -17,14 +17,18 @@
     "SDFI",
     "saul"
   ],
-  "author": "Styrelsen for Dataforsyning og Infrastruktur (https://sdfi.dk/)",
+  "author": {
+    "name": "Styrelsen for Dataforsyning og Infrastruktur",
+    "email": "support@sdfi.dk",
+    "url": "https://sdfi.dk/"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/SDFIdk/saul/issues"
   },
   "homepage": "https://github.com/SDFIdk/saul#readme",
   "devDependencies": {
-    "jsdoc": "^3.6.10"
+    "jsdoc": "^4.0.2"
   },
   "dependencies": {
     "geotiff": "^2.0.5",

package/test/saul-combined.test.js

@@ -1,7 +1,6 @@
-// You should add your own config.js with proper tokens, passwords, etc.
+// You should add your own config.js with proper tokens, etc.
 // Check config.js.example for info on how to set it up
 import auth from '../config.js'
-import assert from 'assert'
 import { getSTAC, getTerrainGeoTIFF,getZ, getWorldXYZ, getImageXY } from '../index.js'
 
 

package/test/saul-core.test.js

@@ -1,6 +1,6 @@
 // Testing saul-core methods
 
-// You should add your own config.js with proper tokens, passwords, etc.
+// You should add your own config.js with proper tokens, etc.
 // Check config.js.example for info on how to set it up
 import auth from '../config.js'
 

package/test/saul-elevation.test.js

@@ -1,4 +1,4 @@
-// You should add your own config.js with proper tokens, passwords, etc.
+// You should add your own config.js with proper tokens, etc.
 // Check config.js.example for info on how to set it up
 import auth from '../config.js'