victory-core 37.3.1 → 37.3.3

package/es/victory-util/helpers.d.ts

@@ -1,6 +1,27 @@
 import React from "react";
-import { CallbackArgs } from "../types/callbacks";
 import { ValueOrAccessor } from "../types/prop-types";
+export type ElementPadding = {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+};
+export type MaybePointData = {
+    x?: number;
+    x0?: number;
+    x1?: number;
+    y?: number;
+    y0?: number;
+    y1?: number;
+    _x?: number;
+    _x0?: number;
+    _x1?: number;
+    _y?: number;
+    _y0?: number;
+    _y1?: number;
+    _voronoiX?: number;
+    _voronoiY?: number;
+};
 /**
  * Creates an object composed of the inverted keys and values of object.
  * If object contains duplicate values, subsequent values overwrite property assignments of previous values.
@@ -14,32 +35,83 @@ export declare function invert(original: Record<string, string | number>): {};
  * @returns {Object} new object with same properties as originalObject
  */
 export declare function omit<T, Keys extends keyof T>(originalObject: T, ks?: Array<Keys>): Omit<T, Keys>;
-export declare function getPoint(datum: any): any;
-export declare function scalePoint(props: any, datum: any): {
-    x: any;
-    x0: any;
-    y: any;
-    y0: any;
-};
-export declare function getPadding(props: any, name?: string): {
-    top: any;
-    bottom: any;
-    left: any;
-    right: any;
+/**
+ * Coalesce the x and y values from a data point
+ */
+export declare function getPoint(datum: MaybePointData): MaybePointData;
+/**
+ * Scale a point based on the origin, direction, and given scale function
+ */
+export declare function scalePoint(props: {
+    scale: {
+        x: (x?: number) => number;
+        y: (y?: number) => number;
+    };
+    polar?: boolean;
+    horizontal?: boolean;
+    origin?: {
+        x: number;
+        y: number;
+    };
+}, datum: MaybePointData): {
+    x: number;
+    x0: number;
+    y: number;
+    y0: number;
 };
-export declare function isTooltip(component: any): boolean;
+/**
+ * Returns a padding value from a number or partial padding values
+ */
+export declare function getPadding(padding?: number | Partial<ElementPadding>): ElementPadding;
+/**
+ * Returns true if the component is defined as a tooltip
+ */
+export declare function isTooltip(component?: {
+    type?: {
+        role?: string;
+    };
+}): boolean;
 export declare function getDefaultStyles(props: any, role: any): any;
 export declare function getStyles(style: any, defaultStyles: any): any;
-export declare function evaluateProp<TValue>(prop: ValueOrAccessor<TValue, CallbackArgs>, props: CallbackArgs): TValue;
+/**
+ * Returns the value of a prop or accessor function with the given props
+ */
+export declare function evaluateProp<TValue>(prop: ValueOrAccessor<TValue, Record<string, any>>, props: Record<string, any>): TValue;
 export declare function evaluateStyle(style: any, props: any): any;
 export declare function degreesToRadians(degrees: any): any;
 export declare function radiansToDegrees(radians: any): any;
-export declare function getRadius(props: any): number;
-export declare function getPolarOrigin(props: any): {
+/**
+ * Get the maximum radius that will fit in the container
+ */
+export declare function getRadius(options: {
+    height: number;
+    width: number;
+    padding: ElementPadding;
+}): number;
+/**
+ * Returns the origin for a polar chart within the padded area
+ */
+export declare function getPolarOrigin(props: {
+    height: number;
+    width: number;
+    padding: ElementPadding;
+}): {
     x: number;
     y: number;
 };
-export declare function getRange(props: any, axis: any): any;
+/**
+ * Determine the range of an axis based on the given props
+ */
+export declare function getRange(props: {
+    range?: [number, number];
+    polar?: boolean;
+    innerRadius?: number;
+    startAngle?: number;
+    endAngle?: number;
+    height: number;
+    width: number;
+    padding: number | Partial<ElementPadding>;
+}, axis: "x" | "y"): any;
 /**
  * Checks if `value` is `null` or `undefined`.
  * @returns {boolean} Returns `true` if `value` is nullish, else `false`.
@@ -93,5 +165,8 @@ export declare function reduceChildren<TChildren extends React.ReactNode, TItem,
  * @returns {Boolean} returns true if the props object contains `horizontal: true` of if any
  * children or nested children are horizontal
  */
-export declare function isHorizontal(props: any): any;
+export declare function isHorizontal(props: {
+    horizontal?: boolean;
+    children?: React.ReactNode;
+}): any;
 //# sourceMappingURL=helpers.d.ts.map

package/es/victory-util/helpers.js

@@ -1,30 +1,34 @@
-import _pick from "lodash/pick";
-import _property from "lodash/property";
-import _defaults from "lodash/defaults";
-/* eslint-disable no-use-before-define */
 import React, { isValidElement } from "react";
-// Private Functions
-
-function getCartesianRange(props, axis) {
-  // determine how to lay the axis and what direction positive and negative are
-  const vertical = axis !== "x";
-  const padding = getPadding(props);
+import defaults from "lodash/defaults";
+import property from "lodash/property";
+import pick from "lodash/pick";
+/**
+ * Determine the range of a cartesian axis
+ */
+function getCartesianRange(options) {
+  const vertical = options.axis !== "x";
   if (vertical) {
-    return [props.height - padding.bottom, padding.top];
+    return [options.height - options.padding.bottom, options.padding.top];
   }
-  return [padding.left, props.width - padding.right];
+  return [options.padding.left, options.width - options.padding.right];
 }
-function getPolarRange(props, axis) {
-  if (axis === "x") {
-    const startAngle = degreesToRadians(props.startAngle || 0);
-    const endAngle = degreesToRadians(props.endAngle || 360);
+
+/**
+ * Determine the range of a polar axis in radians
+ */
+function getPolarRange(options) {
+  if (options.axis === "x") {
+    const startAngle = degreesToRadians(options.startAngle || 0);
+    const endAngle = degreesToRadians(options.endAngle || 360);
     return [startAngle, endAngle];
   }
-  return [props.innerRadius || 0, getRadius(props)];
+  return [options.innerRadius || 0, getRadius({
+    height: options.height,
+    width: options.width,
+    padding: options.padding
+  })];
 }
 
-// Exported Functions
-
 /**
  * Creates an object composed of the inverted keys and values of object.
  * If object contains duplicate values, subsequent values overwrite property assignments of previous values.
@@ -61,8 +65,11 @@ export function omit(originalObject, ks) {
   }
   return newObject;
 }
+
+/**
+ * Coalesce the x and y values from a data point
+ */
 export function getPoint(datum) {
-  const exists = val => val !== undefined;
   const {
     _x,
     _x1,
@@ -73,16 +80,20 @@ export function getPoint(datum) {
     _y0,
     _voronoiY
   } = datum;
-  const defaultX = exists(_x1) ? _x1 : _x;
-  const defaultY = exists(_y1) ? _y1 : _y;
+  const defaultX = _x1 ?? _x;
+  const defaultY = _y1 ?? _y;
   const point = {
-    x: exists(_voronoiX) ? _voronoiX : defaultX,
-    x0: exists(_x0) ? _x0 : _x,
-    y: exists(_voronoiY) ? _voronoiY : defaultY,
-    y0: exists(_y0) ? _y0 : _y
+    x: _voronoiX ?? defaultX,
+    x0: _x0 ?? _x,
+    y: _voronoiY ?? defaultY,
+    y0: _y0 ?? _y
   };
-  return _defaults({}, point, datum);
+  return defaults({}, point, datum);
 }
+
+/**
+ * Scale a point based on the origin, direction, and given scale function
+ */
 export function scalePoint(props, datum) {
   const {
     scale,
@@ -105,11 +116,11 @@ export function scalePoint(props, datum) {
     y0: polar ? -y0 * Math.sin(x0) + origin.x : y0
   };
 }
-export function getPadding(props, name) {
-  if (name === void 0) {
-    name = "padding";
-  }
-  const padding = props[name];
+
+/**
+ * Returns a padding value from a number or partial padding values
+ */
+export function getPadding(padding) {
   const paddingVal = typeof padding === "number" ? padding : 0;
   const paddingObj = typeof padding === "object" ? padding : {};
   return {
@@ -119,6 +130,10 @@ export function getPadding(props, name) {
     right: paddingObj.right || paddingVal
   };
 }
+
+/**
+ * Returns true if the component is defined as a tooltip
+ */
 export function isTooltip(component) {
   const labelRole = component && component.type && component.type.role;
   return labelRole === "tooltip";
@@ -133,8 +148,8 @@ export function getDefaultStyles(props, role) {
     return defaultStyles;
   }
   const tooltipStyle = theme.tooltip && theme.tooltip.style || {};
-  const labelStyle = _defaults({}, tooltipStyle, defaultStyles.labels);
-  return _defaults({}, {
+  const labelStyle = defaults({}, tooltipStyle, defaultStyles.labels);
+  return defaults({}, {
     labels: labelStyle
   }, defaultStyles);
 }
@@ -142,7 +157,7 @@ export function getStyles(style, defaultStyles) {
   const width = "100%";
   const height = "100%";
   if (!style) {
-    return _defaults({
+    return defaults({
       parent: {
         height,
         width
@@ -158,14 +173,18 @@ export function getStyles(style, defaultStyles) {
   const defaultLabels = defaultStyles && defaultStyles.labels || {};
   const defaultData = defaultStyles && defaultStyles.data || {};
   return {
-    parent: _defaults({}, parent, defaultParent, {
+    parent: defaults({}, parent, defaultParent, {
       width,
       height
     }),
-    labels: _defaults({}, labels, defaultLabels),
-    data: _defaults({}, data, defaultData)
+    labels: defaults({}, labels, defaultLabels),
+    data: defaults({}, data, defaultData)
   };
 }
+
+/**
+ * Returns the value of a prop or accessor function with the given props
+ */
 export function evaluateProp(prop, props) {
   return isFunction(prop) ? prop(props) : prop;
 }
@@ -187,19 +206,28 @@ export function degreesToRadians(degrees) {
 export function radiansToDegrees(radians) {
   return typeof radians === "number" ? radians / (Math.PI / 180) : radians;
 }
-export function getRadius(props) {
+
+/**
+ * Get the maximum radius that will fit in the container
+ */
+export function getRadius(options) {
+  const {
+    width,
+    height,
+    padding
+  } = options;
   const {
     left,
     right,
     top,
     bottom
-  } = getPadding(props);
-  const {
-    width,
-    height
-  } = props;
+  } = padding;
   return Math.min(width - left - right, height - top - bottom) / 2;
 }
+
+/**
+ * Returns the origin for a polar chart within the padded area
+ */
 export function getPolarOrigin(props) {
   const {
     width,
@@ -210,7 +238,7 @@ export function getPolarOrigin(props) {
     bottom,
     left,
     right
-  } = getPadding(props);
+  } = getPadding(props.padding);
   const radius = Math.min(width - left - right, height - top - bottom) / 2;
   const offsetWidth = width / 2 + left - right;
   const offsetHeight = height / 2 + top - bottom;
@@ -219,13 +247,30 @@ export function getPolarOrigin(props) {
     y: offsetHeight + radius > height ? radius + top - bottom : offsetHeight
   };
 }
+
+/**
+ * Determine the range of an axis based on the given props
+ */
 export function getRange(props, axis) {
   if (props.range && props.range[axis]) {
     return props.range[axis];
   } else if (props.range && Array.isArray(props.range)) {
     return props.range;
   }
-  return props.polar ? getPolarRange(props, axis) : getCartesianRange(props, axis);
+  return props.polar ? getPolarRange({
+    axis,
+    innerRadius: props.innerRadius,
+    startAngle: props.startAngle,
+    endAngle: props.endAngle,
+    height: props.height,
+    width: props.width,
+    padding: getPadding(props.padding)
+  }) : getCartesianRange({
+    axis,
+    height: props.height,
+    width: props.width,
+    padding: getPadding(props.padding)
+  });
 }
 
 /**
@@ -257,7 +302,7 @@ export function createAccessor(key) {
     return x => x;
   }
   // otherwise, assume it is an array index, property key or path (_.property handles all three)
-  return _property(key);
+  return property(key);
 }
 export function modifyProps(props, fallbackProps, role) {
   const theme = props.theme && props.theme[role] ? props.theme[role] : {};
@@ -266,7 +311,7 @@ export function modifyProps(props, fallbackProps, role) {
   const defaultObject = horizontal === undefined ? {} : {
     horizontal
   };
-  return _defaults(defaultObject, props, themeProps, fallbackProps);
+  return defaults(defaultObject, props, themeProps, fallbackProps);
 }
 
 /**
@@ -353,9 +398,9 @@ initialMemo, combine) {
       const childRole = child.type && child.type.role;
       const childName = child.props.name || `${childRole}-${names[index]}`;
       if (child.props && child.props.children) {
-        const childProps = Object.assign({}, child.props, _pick(parentProps, sharedProps));
+        const childProps = Object.assign({}, child.props, pick(parentProps, sharedProps));
         const nestedChildren = child.type && child.type.role === "stack" && isFunction(child.type.getChildren) ? child.type.getChildren(childProps) : React.Children.toArray(child.props.children).map(c => {
-          const nestedChildProps = Object.assign({}, c.props, _pick(childProps, sharedProps));
+          const nestedChildProps = Object.assign({}, c.props, pick(childProps, sharedProps));
           return /*#__PURE__*/React.cloneElement(c, nestedChildProps);
         });
         const childNames = nestedChildren.map((c, i) => `${childName}-${i}`);

package/es/victory-util/hooks/use-animation-state.d.ts

@@ -1,5 +1,5 @@
-declare type AnyObject = Record<string, any>;
-export declare type AnimationState = {
+type AnyObject = Record<string, any>;
+export type AnimationState = {
     nodesShouldLoad?: boolean;
     nodesDoneLoad?: boolean;
     animating?: boolean;

package/es/victory-util/hooks/use-animation-state.js

@@ -1,5 +1,5 @@
-import _defaults from "lodash/defaults";
 import React from "react";
+import defaults from "lodash/defaults";
 import * as Collection from "../collection";
 import * as Transitions from "../transitions";
 const INITIAL_STATE = {
@@ -29,7 +29,7 @@ export const useAnimationState = function (initialState) {
     const getFilteredState = () => {
       let childrenTransitions = state && state.childrenTransitions;
       childrenTransitions = Collection.isArrayOfArrays(childrenTransitions) ? childrenTransitions[index] : childrenTransitions;
-      return _defaults({
+      return defaults({
         childrenTransitions
       }, state);
     };
@@ -40,7 +40,7 @@ export const useAnimationState = function (initialState) {
       const getTransitionProps = Transitions.getTransitionPropsFactory(props, filteredState, newState => setState(newState));
       getTransitions = childComponent => getTransitionProps(childComponent, index);
     }
-    return _defaults({
+    return defaults({
       getTransitions,
       parentState
     }, props.animate, child.props.animate);
@@ -54,7 +54,7 @@ export const useAnimationState = function (initialState) {
     if (props.animate.parentState) {
       const nodesWillExit = props.animate.parentState.nodesWillExit;
       const oldProps = nodesWillExit ? props : null;
-      const newState = _defaults({
+      const newState = defaults({
         oldProps,
         nextProps
       }, props.animate.parentState);

package/es/victory-util/label-helpers.d.ts

@@ -1,4 +1,5 @@
-export declare function getText(props: any, datum: Record<string, any> | undefined, index: any): any;
+import { VictoryLabelProps } from "../victory-label/victory-label";
+export declare function getText(props: any, datum: VictoryLabelProps["datum"], index: any): any;
 export declare function getPolarTextAnchor(props: any, degrees: any): "end" | "start" | "middle";
 export declare function getPolarVerticalAnchor(props: any, degrees: any): "end" | "start" | "middle";
 export declare function getPolarAngle(props: any, baseAngle?: any): number;
@@ -16,8 +17,8 @@ export declare function getProps(props: any, index: any): {
     text: any;
     textAnchor: any;
     verticalAnchor: any;
-    x: any;
-    y: any;
+    x: number;
+    y: number;
     dx: number | undefined;
     dy: number | undefined;
     width: any;

package/es/victory-util/label-helpers.js

@@ -1,6 +1,6 @@
-import _defaults from "lodash/defaults";
-/* eslint-disable no-use-before-define */
 import * as Helpers from "./helpers";
+import defaults from "lodash/defaults";
+
 // Private Functions
 
 function getVerticalAnchor(props, datum) {
@@ -228,5 +228,5 @@ export function getProps(props, index) {
     return labelProps;
   }
   const tooltipTheme = theme && theme.tooltip || {};
-  return _defaults({}, labelProps, Helpers.omit(tooltipTheme, ["style"]));
+  return defaults({}, labelProps, Helpers.omit(tooltipTheme, ["style"]));
 }

package/es/victory-util/line-helpers.d.ts

@@ -1,5 +1,5 @@
 import * as d3Shape from "victory-vendor/d3-shape";
-export declare type CurveName = "basis" | "cardinal" | "bumpX" | "bumpY" | "bundle" | "catmullRom" | "linear" | "monotoneX" | "monotoneY" | "step" | "stepAfter" | "stepBefore" | "natural";
+export type CurveName = "basis" | "cardinal" | "bumpX" | "bumpY" | "bundle" | "catmullRom" | "linear" | "monotoneX" | "monotoneY" | "step" | "stepAfter" | "stepBefore" | "natural";
 export declare const getInterpolationFunction: (props: any) => any;
 export declare const getLineFunction: (props: any) => d3Shape.LineRadial<[number, number]> | d3Shape.Line<[number, number]>;
 //# sourceMappingURL=line-helpers.d.ts.map

package/es/victory-util/log.js

@@ -1,8 +1,9 @@
-/* global console */
+/* global console process */
 /* eslint-disable no-console */
 
-// TODO: Use "warning" npm module like React is switching to.
 export function warn(message) {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore - Webpack DefinePlugin will replace process.env.NODE_ENV
   if (process.env.NODE_ENV !== "production") {
     if (console && console.warn) {
       console.warn(message);

package/es/victory-util/merge-refs.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="react" />
-declare type Ref<T> = React.MutableRefObject<T> | React.LegacyRef<T> | undefined | null;
+import React from "react";
+type Ref<T> = React.MutableRefObject<T> | React.LegacyRef<T> | undefined | null;
 /**
  * Used to merge multiple React refs into a single callback ref.
  *

package/es/victory-util/scale.js

@@ -1,5 +1,4 @@
-import _isPlainObject from "lodash/isPlainObject";
-/* eslint-disable no-use-before-define */
+import isPlainObject from "lodash/isPlainObject";
 import * as Helpers from "./helpers";
 import * as Collection from "./collection";
 import * as d3Scale from "victory-vendor/d3-scale";
@@ -52,7 +51,7 @@ function getScaleTypeFromData(props, axis) {
   }
   const accessor = Helpers.createAccessor(props[axis]);
   const axisData = props.data.map(datum => {
-    const processedData = _isPlainObject(accessor(datum)) ? accessor(datum)[axis] : accessor(datum);
+    const processedData = isPlainObject(accessor(datum)) ? accessor(datum)[axis] : accessor(datum);
     return processedData !== undefined ? processedData : datum[axis];
   });
   return Collection.containsDates(axisData) ? "time" : "linear";

package/es/victory-util/selection.d.ts

@@ -9,15 +9,15 @@ export declare function getDomainCoordinates(props: Pick<VictoryCommonProps, "sc
 };
 export declare function getDataCoordinates(props: any, scale: ScaleXYPropType, x: number, y: number): SVGCoordinateType;
 export declare function getBounds(props: ComputedCommonProps): SVGCoordinateBounds;
-export declare type SVGCoordinateType = {
+export type SVGCoordinateType = {
     x: number;
     y: number;
 };
-export declare type SVGCoordinateBounds = {
+export type SVGCoordinateBounds = {
     x: readonly [number, number];
     y: readonly [number, number];
 };
-declare type ComputedCommonProps = {
+type ComputedCommonProps = {
     scale: ScaleXYPropType;
     x1: number;
     x2: number;

package/es/victory-util/textsize.js

@@ -1,6 +1,8 @@
-import _memoize from "lodash/memoize";
-import _defaults from "lodash/defaults"; // http://www.pearsonified.com/2012/01/characters-per-line.php
+// http://www.pearsonified.com/2012/01/characters-per-line.php
 /* eslint-disable no-magic-numbers */
+import defaults from "lodash/defaults";
+import memoize from "lodash/memoize";
+
 // Based on measuring specific character widths
 // as in the following example https://bl.ocks.org/tophtucker/62f93a4658387bb61e4510c37e2e97cf
 // For new fonts: pull gist, open index.html locally, add font files (if not generic), enter font name in `font-family` input
@@ -179,7 +181,7 @@ export const convertLengthToPixels = (length, fontSize) => {
 };
 const _prepareParams = (inputStyle, index) => {
   const lineStyle = Array.isArray(inputStyle) ? inputStyle[index] : inputStyle;
-  const style = _defaults({}, lineStyle, defaultStyle);
+  const style = defaults({}, lineStyle, defaultStyle);
   return Object.assign({}, style, {
     fontFamily: style.fontFamily,
     letterSpacing: typeof style.letterSpacing === "number" ? style.letterSpacing : convertLengthToPixels(String(style.letterSpacing), style.fontSize),
@@ -227,7 +229,7 @@ const _approximateDimensionsInternal = (text, style) => {
     height: heightWithRotate * coefficients.heightOverlapCoef
   };
 };
-const _getMeasurementContainer = _memoize(() => {
+const _getMeasurementContainer = memoize(() => {
   const element = document.createElementNS("http://www.w3.org/2000/svg", "svg");
   element.setAttribute("xlink", "http://www.w3.org/1999/xlink");
   element.setAttribute("width", "300");
@@ -248,7 +250,7 @@ const styleToKeyComponent = style => {
   }
   return `${style.angle}:${style.fontFamily}:${style.fontSize}:${style.letterSpacing}:${style.lineHeight}`;
 };
-const _measureDimensionsInternal = _memoize((text, style) => {
+const _measureDimensionsInternal = memoize((text, style) => {
   let containerElement = _getMeasurementContainer();
   if (!containerElement.isConnected) {
     _getMeasurementContainer.cache.clear?.();

package/es/victory-util/timer.d.ts

@@ -1,4 +1,4 @@
-declare type TimerCallback = (elapsed: number, duration: number) => void;
+type TimerCallback = (elapsed: number, duration: number) => void;
 export default class Timer {
     private shouldAnimate;
     private readonly subscribers;

package/es/victory-util/transitions.d.ts

@@ -21,7 +21,7 @@ export declare function getInitialTransitionState(oldChildren: any, nextChildren
     childrenTransitions: any;
     nodesShouldEnter: boolean;
 };
-declare type TransitionProps = {
+type TransitionProps = {
     data: any;
     animate?: AnimatePropTypeInterface;
     clipWidth?: number;