victory-cursor-container 36.6.0 → 36.6.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # victory-cursor-container
 
+## 36.6.1
+
+### Patch Changes
+
+- - Removed Template Literal Types to increase TS compatibility (fixes [#2418](https://github.com/FormidableLabs/victory/issues/2418)) ([#2420](https://github.com/FormidableLabs/victory/pull/2420))
+  - Improved type for `VictoryLabelProps["textAnchor"]` (fixes [#2361](https://github.com/FormidableLabs/victory/issues/2361))
+  - Fixed exported types for `VictoryAxis`, `VictoryBoxPlot`, `VictoryErrorBar`, and `VictoryScatter` (fixes [#2411](https://github.com/FormidableLabs/victory/issues/2411))
+  - Migrate `victory-cursor-container` to TS (fixes [#2402](https://github.com/FormidableLabs/victory/issues/2402))
+- Updated dependencies [[`d1f281104`](https://github.com/FormidableLabs/victory/commit/d1f281104c7598c43e220dafd57546ab03daeeb5)]:
+  - victory-core@36.6.1
+
 ## 36.6.0
 
 ### Patch Changes

package/dist/victory-cursor-container.js

@@ -11,16 +11,16 @@
 return /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
-/***/ "./cursor-helpers.js":
-/*!***************************!*\
-  !*** ./cursor-helpers.js ***!
-  \***************************/
+/***/ "./cursor-helpers.tsx":
+/*!****************************!*\
+  !*** ./cursor-helpers.tsx ***!
+  \****************************/
 /***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
 
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
-/* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
+/* harmony export */   "CursorHelpers": () => (/* binding */ CursorHelpers)
 /* harmony export */ });
 /* harmony import */ var lodash_mapValues__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! lodash/mapValues */ "../../../node_modules/.pnpm/lodash@4.17.21/node_modules/lodash/mapValues.js");
 /* harmony import */ var lodash_mapValues__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(lodash_mapValues__WEBPACK_IMPORTED_MODULE_0__);
@@ -33,116 +33,151 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
 
 var ON_MOUSE_MOVE_THROTTLE_MS = 16;
-var CursorHelpers = {
-  getDimension: function (props) {
-    var horizontal = props.horizontal,
-        cursorDimension = props.cursorDimension;
 
-    if (!horizontal || !cursorDimension) {
-      return cursorDimension;
-    }
+var CursorHelpersClass = /*#__PURE__*/function () {
+  function CursorHelpersClass() {
+    var _this = this;
 
-    return cursorDimension === "x" ? "y" : "x";
-  },
-  withinBounds: function (point, bounds) {
-    var _mapValues2 = lodash_mapValues__WEBPACK_IMPORTED_MODULE_0___default()(bounds, Number),
-        x1 = _mapValues2.x1,
-        x2 = _mapValues2.x2,
-        y1 = _mapValues2.y1,
-        y2 = _mapValues2.y2;
-
-    var _mapValues3 = lodash_mapValues__WEBPACK_IMPORTED_MODULE_0___default()(point, Number),
-        x = _mapValues3.x,
-        y = _mapValues3.y;
-
-    return x >= Math.min(x1, x2) && x <= Math.max(x1, x2) && y >= Math.min(y1, y2) && y <= Math.max(y1, y2);
-  },
-  onMouseMove: function (evt, targetProps) {
-    var onCursorChange = targetProps.onCursorChange,
-        domain = targetProps.domain;
-    var cursorDimension = this.getDimension(targetProps);
-    var parentSVG = targetProps.parentSVG || victory_core__WEBPACK_IMPORTED_MODULE_3__.getParentSVG(evt);
-    var cursorSVGPosition = victory_core__WEBPACK_IMPORTED_MODULE_3__.getSVGEventCoordinates(evt, parentSVG);
-    var cursorValue = victory_core__WEBPACK_IMPORTED_MODULE_3__.getDataCoordinates(targetProps, targetProps.scale, cursorSVGPosition.x, cursorSVGPosition.y);
-    var inBounds = this.withinBounds(cursorValue, {
-      x1: domain.x[0],
-      x2: domain.x[1],
-      y1: domain.y[0],
-      y2: domain.y[1]
-    });
+    _classCallCheck(this, CursorHelpersClass);
 
-    if (!inBounds) {
-      cursorValue = null;
-    }
+    this.handleMouseMove = function (evt, targetProps) {
+      var onCursorChange = targetProps.onCursorChange,
+          domain = targetProps.domain;
+
+      var cursorDimension = _this.getDimension(targetProps);
+
+      var parentSVG = targetProps.parentSVG || victory_core__WEBPACK_IMPORTED_MODULE_3__.getParentSVG(evt);
+      var cursorSVGPosition = victory_core__WEBPACK_IMPORTED_MODULE_3__.getSVGEventCoordinates(evt, parentSVG);
+      var cursorValue = victory_core__WEBPACK_IMPORTED_MODULE_3__.getDataCoordinates(targetProps, targetProps.scale, cursorSVGPosition.x, cursorSVGPosition.y);
+
+      var inBounds = _this.withinBounds(cursorValue, {
+        x1: domain.x[0],
+        x2: domain.x[1],
+        y1: domain.y[0],
+        y2: domain.y[1]
+      });
 
-    if (lodash_isFunction__WEBPACK_IMPORTED_MODULE_1___default()(onCursorChange)) {
-      if (inBounds) {
-        var value = cursorDimension ? cursorValue[cursorDimension] : cursorValue;
-        onCursorChange(value, targetProps);
-      } else if (cursorValue !== targetProps.cursorValue) {
-        onCursorChange(targetProps.defaultCursorValue || null, targetProps);
+      if (!inBounds) {
+        cursorValue = null;
       }
-    }
 
-    return [{
-      target: "parent",
-      eventKey: "parent",
-      mutation: function () {
-        return {
-          cursorValue: cursorValue,
-          parentSVG: parentSVG
-        };
+      if (lodash_isFunction__WEBPACK_IMPORTED_MODULE_1___default()(onCursorChange)) {
+        if (cursorValue) {
+          var value = cursorDimension ? cursorValue[cursorDimension] : cursorValue;
+          onCursorChange(value, targetProps);
+        } else if (cursorValue !== targetProps.cursorValue) {
+          onCursorChange(targetProps.defaultCursorValue || null, targetProps);
+        }
       }
-    }];
-  },
-  onTouchEnd: function (evt, targetProps) {
-    var onCursorChange = targetProps.onCursorChange;
 
-    if (lodash_isFunction__WEBPACK_IMPORTED_MODULE_1___default()(targetProps.onCursorChange)) {
-      onCursorChange(null, targetProps);
-    }
+      return [{
+        target: "parent",
+        eventKey: "parent",
+        mutation: function () {
+          return {
+            cursorValue: cursorValue,
+            parentSVG: parentSVG
+          };
+        }
+      }];
+    };
 
-    return [{
-      target: "parent",
-      eventKey: "parent",
-      mutation: function () {
-        return {
-          cursorValue: null
-        };
+    this.onMouseMove = lodash_throttle__WEBPACK_IMPORTED_MODULE_2___default()(this.handleMouseMove, ON_MOUSE_MOVE_THROTTLE_MS, {
+      leading: true,
+      trailing: false
+    });
+    this.onMouseLeave = this.handleMouseMove;
+
+    this.onTouchEnd = function (evt, targetProps) {
+      var onCursorChange = targetProps.onCursorChange;
+
+      if (lodash_isFunction__WEBPACK_IMPORTED_MODULE_1___default()(targetProps.onCursorChange)) {
+        onCursorChange(null, targetProps);
       }
-    }];
+
+      return [{
+        target: "parent",
+        eventKey: "parent",
+        mutation: function () {
+          return {
+            cursorValue: null
+          };
+        }
+      }];
+    };
   }
-};
-/* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (_objectSpread(_objectSpread({}, CursorHelpers), {}, {
-  onMouseMove: lodash_throttle__WEBPACK_IMPORTED_MODULE_2___default()(CursorHelpers.onMouseMove.bind(CursorHelpers), ON_MOUSE_MOVE_THROTTLE_MS, {
-    leading: true,
-    trailing: false
-  }),
+
+  _createClass(CursorHelpersClass, [{
+    key: "getDimension",
+    value: function getDimension(props) {
+      var horizontal = props.horizontal,
+          cursorDimension = props.cursorDimension;
+
+      if (!horizontal || !cursorDimension) {
+        return cursorDimension;
+      }
+
+      return cursorDimension === "x" ? "y" : "x";
+    }
+  }, {
+    key: "withinBounds",
+    value: function withinBounds(point, bounds) {
+      var _mapValues2 = lodash_mapValues__WEBPACK_IMPORTED_MODULE_0___default()(bounds, Number),
+          x1 = _mapValues2.x1,
+          x2 = _mapValues2.x2,
+          y1 = _mapValues2.y1,
+          y2 = _mapValues2.y2;
+
+      var _mapValues3 = lodash_mapValues__WEBPACK_IMPORTED_MODULE_0___default()(point, Number),
+          x = _mapValues3.x,
+          y = _mapValues3.y;
+
+      return x >= Math.min(x1, x2) && x <= Math.max(x1, x2) && y >= Math.min(y1, y2) && y <= Math.max(y1, y2);
+    }
+  }]);
+
+  return CursorHelpersClass;
+}();
+
+var CursorHelpers = new CursorHelpersClass();
+/* {
+  ...CursorHelpers,
+  onMouseMove: throttle(
+    CursorHelpers.onMouseMove.bind(CursorHelpers),
+    ON_MOUSE_MOVE_THROTTLE_MS,
+    {
+      leading: true,
+      trailing: false,
+    },
+  ),
   onMouseLeave: CursorHelpers.onMouseMove.bind(CursorHelpers),
-  onTouchEnd: CursorHelpers.onTouchEnd.bind(CursorHelpers)
-}));
+  onTouchEnd: CursorHelpers.onTouchEnd.bind(CursorHelpers),
+};
+
+
+   */
 
 /***/ }),
 
-/***/ "./victory-cursor-container.js":
-/*!*************************************!*\
-  !*** ./victory-cursor-container.js ***!
-  \*************************************/
+/***/ "./victory-cursor-container.tsx":
+/*!**************************************!*\
+  !*** ./victory-cursor-container.tsx ***!
+  \**************************************/
 /***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
 
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
-/* harmony export */   "cursorContainerMixin": () => (/* binding */ cursorContainerMixin),
-/* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
+/* harmony export */   "VictoryCursorContainer": () => (/* binding */ VictoryCursorContainer),
+/* harmony export */   "cursorContainerMixin": () => (/* binding */ cursorContainerMixin)
 /* harmony export */ });
 /* harmony import */ var lodash_isObject__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! lodash/isObject */ "../../../node_modules/.pnpm/lodash@4.17.21/node_modules/lodash/isObject.js");
 /* harmony import */ var lodash_isObject__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(lodash_isObject__WEBPACK_IMPORTED_MODULE_0__);
@@ -158,7 +193,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var victory_core__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! victory-core */ "../../victory-core/es/victory-container/victory-container.js");
 /* harmony import */ var victory_core__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(/*! victory-core */ "../../victory-core/es/victory-label/victory-label.js");
 /* harmony import */ var victory_core__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(/*! victory-core */ "../../victory-core/es/victory-primitives/line-segment.js");
-/* harmony import */ var _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./cursor-helpers */ "./cursor-helpers.js");
+/* harmony import */ var _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./cursor-helpers */ "./cursor-helpers.tsx");
 
 
 
@@ -205,11 +240,12 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 
 
 
-var cursorContainerMixin = function (base) {
+function cursorContainerMixin(Base) {
   var _class;
 
-  return _class = /*#__PURE__*/function (_base) {
-    _inherits(VictoryCursorContainer, _base);
+  // @ts-expect-error "TS2545: A mixin class must have a constructor with a single rest parameter of type 'any[]'."
+  return _class = /*#__PURE__*/function (_Base) {
+    _inherits(VictoryCursorContainer, _Base);
 
     var _super = _createSuper(VictoryCursorContainer);
 
@@ -279,7 +315,7 @@ var cursorContainerMixin = function (base) {
             name = props.name,
             horizontal = props.horizontal,
             theme = props.theme;
-        var cursorDimension = _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__["default"].getDimension(props);
+        var cursorDimension = _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__.CursorHelpers.getDimension(props);
         var cursorValue = this.getCursorPosition(props);
         var cursorLabelOffset = this.getCursorLabelOffset(props);
 
@@ -352,7 +388,7 @@ var cursorContainerMixin = function (base) {
     }]);
 
     return VictoryCursorContainer;
-  }(base), _class.displayName = "VictoryCursorContainer", _class.propTypes = _objectSpread(_objectSpread({}, victory_core__WEBPACK_IMPORTED_MODULE_6__.VictoryContainer.propTypes), {}, {
+  }(Base), _class.displayName = "VictoryCursorContainer", _class.propTypes = _objectSpread(_objectSpread({}, victory_core__WEBPACK_IMPORTED_MODULE_6__.VictoryContainer.propTypes), {}, {
     cursorDimension: prop_types__WEBPACK_IMPORTED_MODULE_7___default().oneOf(["x", "y"]),
     cursorLabel: (prop_types__WEBPACK_IMPORTED_MODULE_7___default().func),
     cursorLabelComponent: (prop_types__WEBPACK_IMPORTED_MODULE_7___default().element),
@@ -378,22 +414,22 @@ var cursorContainerMixin = function (base) {
       target: "parent",
       eventHandlers: {
         onMouseLeave: function (evt, targetProps) {
-          return props.disable ? {} : _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__["default"].onMouseLeave(evt, targetProps);
+          return props.disable ? {} : _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__.CursorHelpers.onMouseLeave(evt, targetProps);
         },
         onTouchCancel: function () {
           return [];
         },
         onMouseMove: function (evt, targetProps) {
-          return props.disable ? {} : _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__["default"].onMouseMove(evt, targetProps);
+          return props.disable ? {} : _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__.CursorHelpers.onMouseMove(evt, targetProps);
         },
         onTouchMove: function (evt, targetProps) {
-          return props.disable ? {} : _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__["default"].onMouseMove(evt, targetProps);
+          return props.disable ? {} : _cursor_helpers__WEBPACK_IMPORTED_MODULE_5__.CursorHelpers.onMouseMove(evt, targetProps);
         }
       }
     }];
   }, _class;
-};
-/* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (cursorContainerMixin(victory_core__WEBPACK_IMPORTED_MODULE_6__.VictoryContainer));
+}
+var VictoryCursorContainer = cursorContainerMixin(victory_core__WEBPACK_IMPORTED_MODULE_6__.VictoryContainer);
 
 /***/ }),
 
@@ -9343,7 +9379,9 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 var USER_PROPS_SAFELIST = {
   startsWith: ["data-", "aria-"],
   exactMatch: []
-};
+}; // Normally we'd use Template Literal Types, but we're avoiding it to maximize TS compatibility with TS < 4.1
+
+// `data-${string}` | `aria-${string}`;
 
 /**
  * doesPropStartWith: Function that takes a prop's key and runs it against all
@@ -15270,17 +15308,17 @@ var __webpack_exports__ = {};
 // This entry need to be wrapped in an IIFE because it need to be in strict mode.
 (() => {
 "use strict";
-/*!******************!*\
-  !*** ./index.js ***!
-  \******************/
+/*!*******************!*\
+  !*** ./index.tsx ***!
+  \*******************/
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
-/* harmony export */   "CursorHelpers": () => (/* reexport safe */ _cursor_helpers__WEBPACK_IMPORTED_MODULE_1__["default"]),
-/* harmony export */   "VictoryCursorContainer": () => (/* reexport safe */ _victory_cursor_container__WEBPACK_IMPORTED_MODULE_0__["default"]),
-/* harmony export */   "cursorContainerMixin": () => (/* reexport safe */ _victory_cursor_container__WEBPACK_IMPORTED_MODULE_0__.cursorContainerMixin)
+/* harmony export */   "CursorHelpers": () => (/* reexport safe */ _cursor_helpers__WEBPACK_IMPORTED_MODULE_0__.CursorHelpers),
+/* harmony export */   "VictoryCursorContainer": () => (/* reexport safe */ _victory_cursor_container__WEBPACK_IMPORTED_MODULE_1__.VictoryCursorContainer),
+/* harmony export */   "cursorContainerMixin": () => (/* reexport safe */ _victory_cursor_container__WEBPACK_IMPORTED_MODULE_1__.cursorContainerMixin)
 /* harmony export */ });
-/* harmony import */ var _victory_cursor_container__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./victory-cursor-container */ "./victory-cursor-container.js");
-/* harmony import */ var _cursor_helpers__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./cursor-helpers */ "./cursor-helpers.js");
+/* harmony import */ var _cursor_helpers__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./cursor-helpers */ "./cursor-helpers.tsx");
+/* harmony import */ var _victory_cursor_container__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./victory-cursor-container */ "./victory-cursor-container.tsx");
 
 
 })();