@opengeoweb/webmap 5.0.0 → 5.1.0

package/index.js

@@ -29,14 +29,14 @@ function _iterableToArrayLimit(arr, i) {
     return _arr;
   }
 }
-function _typeof(obj) {
+function _typeof$1(obj) {
   "@babel/helpers - typeof";
 
-  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
+  return _typeof$1 = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
     return typeof obj;
   } : function (obj) {
     return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
-  }, _typeof(obj);
+  }, _typeof$1(obj);
 }
 function _classCallCheck(instance, Constructor) {
   if (!(instance instanceof Constructor)) {
@@ -17764,7 +17764,7 @@ var flattenLayerTree = function flattenLayerTree(layerTree) {
   var omit = function omit(prop, _a) {
     var _b = prop;
       _a[_b];
-      var rest = __rest(_a, [_typeof(_b) === "symbol" ? _b : _b + ""]);
+      var rest = __rest(_a, [_typeof$1(_b) === "symbol" ? _b : _b + ""]);
     return rest;
   };
   var recurseLayerTree = function recurseLayerTree(data) {
@@ -18390,7 +18390,7 @@ var WMBBOX = /*#__PURE__*/function () {
       /* Check if we recieve more than one parameter by checking the second bottom parameter. */
       if (bottom === undefined) {
         /* Otherwise it can be a bbox object or a string in the form "left,bottom,right,top" */
-        if (_typeof(left) === 'object') {
+        if (_typeof$1(left) === 'object') {
           /* A bbox object is given, so it is not a string */
           var a = left;
           this.left = a.left;
@@ -25258,6 +25258,117 @@ var moment$1 = {exports: {}};
 
 var moment = moment$1.exports;
 
+function requiredArgs(required, args) {
+  if (args.length < required) {
+    throw new TypeError(required + ' argument' + (required > 1 ? 's' : '') + ' required, but only ' + args.length + ' present');
+  }
+}
+
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+/**
+ * @name toDate
+ * @category Common Helpers
+ * @summary Convert the given argument to an instance of Date.
+ *
+ * @description
+ * Convert the given argument to an instance of Date.
+ *
+ * If the argument is an instance of Date, the function returns its clone.
+ *
+ * If the argument is a number, it is treated as a timestamp.
+ *
+ * If the argument is none of the above, the function returns Invalid Date.
+ *
+ * **Note**: *all* Date arguments passed to any *date-fns* function is processed by `toDate`.
+ *
+ * @param {Date|Number} argument - the value to convert
+ * @returns {Date} the parsed date in the local time zone
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // Clone the date:
+ * const result = toDate(new Date(2014, 1, 11, 11, 30, 30))
+ * //=> Tue Feb 11 2014 11:30:30
+ *
+ * @example
+ * // Convert the timestamp to date:
+ * const result = toDate(1392098430000)
+ * //=> Tue Feb 11 2014 11:30:30
+ */
+
+function toDate(argument) {
+  requiredArgs(1, arguments);
+  var argStr = Object.prototype.toString.call(argument); // Clone the date
+
+  if (argument instanceof Date || _typeof(argument) === 'object' && argStr === '[object Date]') {
+    // Prevent the date to lose the milliseconds when passed to new Date() in IE10
+    return new Date(argument.getTime());
+  } else if (typeof argument === 'number' || argStr === '[object Number]') {
+    return new Date(argument);
+  } else {
+    if ((typeof argument === 'string' || argStr === '[object String]') && typeof console !== 'undefined') {
+      // eslint-disable-next-line no-console
+      console.warn("Starting with v2.0.0-beta.1 date-fns doesn't accept strings as date arguments. Please use `parseISO` to parse strings. See: https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#string-arguments"); // eslint-disable-next-line no-console
+
+      console.warn(new Error().stack);
+    }
+
+    return new Date(NaN);
+  }
+}
+
+/**
+ * @name isWithinInterval
+ * @category Interval Helpers
+ * @summary Is the given date within the interval?
+ *
+ * @description
+ * Is the given date within the interval? (Including start and end.)
+ *
+ * @param {Date|Number} date - the date to check
+ * @param {Interval} interval - the interval to check
+ * @returns {Boolean} the date is within the interval
+ * @throws {TypeError} 2 arguments required
+ * @throws {RangeError} The start of an interval cannot be after its end
+ * @throws {RangeError} Date in interval cannot be `Invalid Date`
+ *
+ * @example
+ * // For the date within the interval:
+ * isWithinInterval(new Date(2014, 0, 3), {
+ *   start: new Date(2014, 0, 1),
+ *   end: new Date(2014, 0, 7)
+ * })
+ * //=> true
+ *
+ * @example
+ * // For the date outside of the interval:
+ * isWithinInterval(new Date(2014, 0, 10), {
+ *   start: new Date(2014, 0, 1),
+ *   end: new Date(2014, 0, 7)
+ * })
+ * //=> false
+ *
+ * @example
+ * // For date equal to interval start:
+ * isWithinInterval(date, { start, end: date }) // => true
+ *
+ * @example
+ * // For date equal to interval end:
+ * isWithinInterval(date, { start: date, end }) // => true
+ */
+function isWithinInterval(dirtyDate, interval) {
+  requiredArgs(2, arguments);
+  var time = toDate(dirtyDate).getTime();
+  var startTime = toDate(interval.start).getTime();
+  var endTime = toDate(interval.end).getTime(); // Throw an exception if start date is after end date or if any date is `Invalid Date`
+
+  if (!(startTime <= endTime)) {
+    throw new RangeError('Invalid interval');
+  }
+
+  return time >= startTime && time <= endTime;
+}
+
 /** ************************************************ */
 /* Object to store a time duration / time interval */
 /** ************************************************ */
@@ -25700,10 +25811,10 @@ var ParseISOTimeRangeDuration = /*#__PURE__*/function () {
     /* Calculates the time step at the given date  */
   }, {
     key: "getTimeStepFromDate",
-    value: function getTimeStepFromDate(currentDate) {
+    value: function getTimeStepFromDate(wantedDate) {
       var throwIfOutsideRange = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-      var currentDateTime = currentDate.getTime();
-      if (currentDateTime < this.startTime.getTime()) {
+      var wantedTime = wantedDate.getTime();
+      if (wantedTime < this.startTime.getTime()) {
         if (throwIfOutsideRange === true) {
           throw new Error('0');
         }
@@ -25711,30 +25822,38 @@ var ParseISOTimeRangeDuration = /*#__PURE__*/function () {
       }
       var myStopTime = this.stopTime.clone();
       myStopTime.add(this.timeInterval);
-      if (currentDateTime >= myStopTime.getTime()) {
+      if (wantedTime >= myStopTime.getTime()) {
         if (throwIfOutsideRange === true) {
           throw new Error("".concat(this.timeSteps - 1));
         }
         return this.timeSteps - 1;
       }
-      if (currentDateTime > this.stopTime.getTime()) {
+      if (wantedTime > this.stopTime.getTime()) {
         return this.timeSteps - 1;
       }
       var timeStep = 0;
       if (this.timeInterval.isRegularInterval === false) {
-        var temptime = this.startTime.clone();
-        for (var j = 0; j < this.timeSteps; j += 1) {
-          var temptimeTime = temptime.getTime();
-          temptime.add(this.timeInterval);
-          var temptimeTimeIsOneStepFurther = temptime.getTime();
-          if (currentDateTime >= temptimeTime && currentDateTime < temptimeTimeIsOneStepFurther) {
-            return j;
+        var next = this.startTime.clone();
+        for (var currentTimeStepIndex = 0; currentTimeStepIndex < this.timeSteps; currentTimeStepIndex += 1) {
+          var currentTime = next.getTime();
+          next.add(this.timeInterval);
+          var nextTime = next.getTime();
+          if (isWithinInterval(wantedTime, {
+            start: currentTime,
+            end: nextTime
+          })) {
+            var timeInTheMiddle = (currentTime + nextTime) / 2;
+            if (wantedTime > timeInTheMiddle) {
+              return currentTimeStepIndex + 1;
+            }
+            return currentTimeStepIndex;
           }
         }
-        throw new Error("Date ".concat(currentDate.toISO8601(), " not found!"));
+        throw new Error("Date ".concat(wantedDate.toISO8601(), " not found!"));
       } else {
-        timeStep = (currentDate.getTime() - this.startTime.getTime()) / this.timeInterval.getTime();
-        timeStep = parseInt(timeStep, 10);
+        timeStep = (wantedDate.getTime() - this.startTime.getTime()) / this.timeInterval.getTime();
+        // round 4.5 down to 4 by using this hack
+        timeStep = -Math.round(-timeStep);
         return timeStep;
       }
     }
@@ -25783,15 +25902,12 @@ var WMJSDimension = /*#__PURE__*/function () {
     this.name = undefined; // Name of the dimension, e.g. 'time'
     this.units = undefined; // Units of the dimension, e.g. 'ISO8601'
     this.unitSymbol = undefined; // Unit symbol, eg: hPa
-    this.values = undefined; // Values of the dimension, according to values defined in WMS specification, e.g. 2011-01-01T00:00:00Z/2012-01-01T00:00:00Z/P1M or list of values.
-    this.timeRangeDuration = undefined;
     this.linked = true;
     this.synced = false;
-    /* Private starts with _ */
     this._initialized = false;
     this._timeRangeDurationDate = null; // Used for timerange (start/stop/res)
     this._allDates = []; // Used for individual timevalues
-    this._type = null; // Can be 'timestartstopres', 'timevalues' or 'anyvalue'
+    this._type = null;
     this._allValues = [];
     this.setTimeValuesForReferenceTime = this.setTimeValuesForReferenceTime.bind(this);
     this.generateAllValues = this.generateAllValues.bind(this);
@@ -25915,6 +26031,7 @@ var WMJSDimension = /*#__PURE__*/function () {
   }, {
     key: "initialize",
     value: function initialize() {
+      var _this = this;
       var forceothervalues = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : undefined;
       var forceReferenceTimeValue = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
       if (this._initialized === true) {
@@ -25943,21 +26060,21 @@ var WMJSDimension = /*#__PURE__*/function () {
       }
       if (this._type !== 'timestartstopres') {
         var values = ogcdimvalues.split(',');
-        for (var j = 0; j < values.length; j += 1) {
-          var valuesRangedNoTrim = values[j].split('/');
+        values.forEach(function (value) {
+          var valuesRangedNoTrim = value.split('/');
           if (valuesRangedNoTrim.length === 3) {
             var valuesRanged = valuesRangedNoTrim.map(function (value) {
               return value.trim();
             });
             /* Can be either time like '2021-03-17T06:00:00Z/2021-03-21T00:00:00Z/PT6H' or something else, like '0/24/2' */
             if (valuesRanged[2].charAt(0) === 'P') {
-              var partTimeRanges = new ParseISOTimeRangeDuration(values[j]);
+              var partTimeRanges = new ParseISOTimeRangeDuration(value);
               for (var i = 0; i < partTimeRanges.getTimeSteps(); i += 1) {
                 var dataAtTimeStep = partTimeRanges.getDateAtTimeStep(i);
                 try {
-                  this._allValues.push(dataAtTimeStep.toISO8601());
+                  _this._allValues.push(dataAtTimeStep.toISO8601());
                 } catch (e) {
-                  this._allValues.push(dataAtTimeStep.toString());
+                  _this._allValues.push(dataAtTimeStep.toString());
                 }
               }
             } else {
@@ -25972,18 +26089,18 @@ var WMJSDimension = /*#__PURE__*/function () {
                 res = 1;
               }
               for (var j2 = start; j2 < stop; j2 += res) {
-                this._allValues.push(String(j2));
+                _this._allValues.push(String(j2));
               }
             }
           } else {
-            this._allValues.push(String(values[j]));
+            _this._allValues.push(String(value));
           }
-        }
+        });
         if (this._type === 'timevalues') {
           this._allDates.length = 0;
-          for (var _j = 0; _j < this._allValues.length; _j += 1) {
-            this._allDates.push(parseISO8601DateToDate(this._allValues[_j]));
-          }
+          this._allValues.forEach(function (value) {
+            _this._allDates.push(parseISO8601DateToDate(value));
+          });
         }
       }
       /* If no default value is given, take the last / most recent one */
@@ -26196,10 +26313,7 @@ var WMJSDimension = /*#__PURE__*/function () {
         }
         return this._timeRangeDurationDate.getDateAtTimeStep(index);
       }
-      if (this._type === 'timevalues') {
-        return this._allValues[index];
-      }
-      if (this._type === 'anyvalue') {
+      if (this._type === 'timevalues' || this._type === 'anyvalue') {
         return this._allValues[index];
       }
       return null;
@@ -26261,12 +26375,14 @@ var WMJSDimension = /*#__PURE__*/function () {
      * Get index value for specified value. Returns the index in the store for the given time value, either a date or a iso8601 string can be passes as input.
      * @param value Either a JS Date object or an ISO8601 String
      * @return The index of the value.  If outSideOfRangeFlag is false, a valid index will
-     * always be returned. If outSideOfRangeFlag is true: -1 if the index is not in the store,
-     * but is lower than available values, -2 if the index is not in store, but is higher than available values
+     * always be returned. If outSideOfRangeFlag is true:
+     * -1 if the value is not in the store, and is lower than available values,
+     * -2 if the value is not in the store, and is higher than available values
      */
   }, {
     key: "getIndexForValue",
     value: function getIndexForValue(value) {
+      var _this2 = this;
       var outSideOfRangeFlag = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
       this.initialize();
       if (typeof value === 'string') {
@@ -26289,36 +26405,33 @@ var WMJSDimension = /*#__PURE__*/function () {
       }
       if (this._type === 'timevalues') {
         try {
-          var dateToFind = parseISO8601DateToDate(value).getTime();
+          var wantedTime = parseISO8601DateToDate(value).getTime();
           var minDistance = null;
           var foundIndex = 0;
-          var minTime = null;
-          var maxTime = null;
-          for (var j = 0; j < this._allValues.length; j += 1) {
-            var time = this._allDates[j].getTime();
-            if (time < minTime || minTime === null) {
-              minTime = time;
+          var startTime = null;
+          var stopTime = null;
+          this._allValues.forEach(function (_, valueIndex) {
+            var currentTime = _this2._allDates[valueIndex].getTime();
+            if (currentTime < startTime || startTime === null) {
+              startTime = currentTime;
             }
-            if (time > maxTime || maxTime === null) {
-              maxTime = time;
+            if (currentTime > stopTime || stopTime === null) {
+              stopTime = currentTime;
             }
-            var distance = time - dateToFind;
-            if (distance < 0) {
-              distance = -distance;
-            }
-            if (j === 0) {
+            var distance = Math.abs(currentTime - wantedTime);
+            if (valueIndex === 0) {
               minDistance = distance;
             }
-            if (distance < minDistance) {
+            if (minDistance > distance) {
               minDistance = distance;
-              foundIndex = j;
+              foundIndex = valueIndex;
             }
-          }
+          });
           if (outSideOfRangeFlag) {
-            if (minTime > dateToFind) {
+            if (startTime > wantedTime) {
               return -1;
             }
-            if (maxTime < dateToFind) {
+            if (stopTime < wantedTime) {
               return -2;
             }
           }
@@ -26329,9 +26442,9 @@ var WMJSDimension = /*#__PURE__*/function () {
         }
       }
       if (this._type === 'anyvalue') {
-        for (var _j2 = 0; _j2 < this._allValues.length; _j2 += 1) {
-          if (this._allValues[_j2] === value) {
-            return _j2;
+        for (var j = 0; j < this._allValues.length; j += 1) {
+          if (this._allValues[j] === value) {
+            return j;
           }
         }
       }
@@ -27760,7 +27873,7 @@ var WMJSMap = /*#__PURE__*/function () {
       if (!_srs) {
         _srs = 'EPSG:4326';
       }
-      if (_typeof(_srs) === 'object') {
+      if (_typeof$1(_srs) === 'object') {
         _bbox = _srs.bbox;
         _srs = _srs.srs;
       }
@@ -28007,7 +28120,7 @@ var WMJSMap = /*#__PURE__*/function () {
       if (this.isDestroyed) {
         return;
       }
-      if (_typeof(animationList) === 'object') {
+      if (_typeof$1(animationList) === 'object') {
         if (JSON.stringify(animationList) !== '{}') {
           this._animationList = animationList;
         }
@@ -28047,7 +28160,7 @@ var WMJSMap = /*#__PURE__*/function () {
       this.callBack.triggerEvent('beforedraw');
       if (this.isAnimating === false) {
         if (animationList !== undefined) {
-          if (_typeof(animationList) === 'object') {
+          if (_typeof$1(animationList) === 'object') {
             if (animationList.length > 0) {
               // Ensure the time dimension has been loaded for the map before starting animation
               var timeDim = this.getDimension('time');
@@ -30793,7 +30906,7 @@ var WMLayer = /*#__PURE__*/function () {
   }, {
     key: "setOpacity",
     value: function setOpacity(opacityValue) {
-      this.opacity = parseFloat(opacityValue);
+      this.opacity = opacityValue;
       this.parentMap && this.parentMap.redrawBuffer();
     }
   }, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/webmap",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "GeoWeb webmap library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -13,7 +13,8 @@
   "types": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
-    "@opengeoweb/shared": "5.0.0",
+    "@opengeoweb/shared": "5.1.0",
+    "date-fns": "2.29.3",
     "lodash": "4.17.21",
     "moment": "2.29.4",
     "proj4": "2.9.0",

package/src/lib/components/WMJSDimension.d.ts

@@ -85,8 +85,9 @@ export default class WMJSDimension {
      * Get index value for specified value. Returns the index in the store for the given time value, either a date or a iso8601 string can be passes as input.
      * @param value Either a JS Date object or an ISO8601 String
      * @return The index of the value.  If outSideOfRangeFlag is false, a valid index will
-     * always be returned. If outSideOfRangeFlag is true: -1 if the index is not in the store,
-     * but is lower than available values, -2 if the index is not in store, but is higher than available values
+     * always be returned. If outSideOfRangeFlag is true:
+     * -1 if the value is not in the store, and is lower than available values,
+     * -2 if the value is not in the store, and is higher than available values
      */
     getIndexForValue(value: string, outSideOfRangeFlag?: boolean): number;
     /**

package/src/lib/components/WMLayer.d.ts

@@ -110,7 +110,7 @@ export default class WMLayer {
     getLayerName(): string;
     toggleAutoUpdate(): void;
     setAutoUpdate(val: boolean, interval?: number, callback?: () => void): void;
-    setOpacity(opacityValue: string): void;
+    setOpacity(opacityValue: number): void;
     getOpacity(): number;
     remove(): void;
     moveUp(): void;

package/src/lib/components/WMTime.d.ts

@@ -35,7 +35,7 @@ export declare class ParseISOTimeRangeDuration {
     getTimeSteps(): number;
     getDateAtTimeStep(currentStep: number): CustomDate;
     getTimeStepFromISODate(currentISODate: string, throwIfOutsideRange: boolean): number;
-    getTimeStepFromDate(currentDate: CustomDate, throwIfOutsideRange?: boolean): number;
+    getTimeStepFromDate(wantedDate: CustomDate, throwIfOutsideRange?: boolean): number;
     getTimeStepFromDateWithinRange(currentDate: CustomDate): number;
     getTimeStepFromDateClipped(currentDate: CustomDate): number;
 }