victory-scatter 36.6.0 → 36.6.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # victory-scatter
 
+## 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-scatter.js

@@ -14368,7 +14368,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

package/es/victory-scatter.d.ts

@@ -1,5 +1,6 @@
+import PropTypes from "prop-types";
 import React from "react";
-import { EventPropTypeInterface, ScatterSymbolType, StringOrNumberOrCallback, VictoryCommonProps, VictoryDatableProps, VictoryMultiLabelableProps, VictoryStyleInterface } from "victory-core";
+import { Data, Domain, EventPropTypeInterface, ScatterSymbolType, StringOrNumberOrCallback, EventsMixinClass, VictoryCommonProps, VictoryDatableProps, VictoryMultiLabelableProps, VictoryStyleInterface } from "victory-core";
 export declare type VictoryScatterTTargetType = "data" | "labels" | "parent";
 export interface VictoryScatterProps extends VictoryCommonProps, VictoryDatableProps, VictoryMultiLabelableProps {
     bubbleProperty?: string;
@@ -16,5 +17,144 @@ export interface VictoryScatterProps extends VictoryCommonProps, VictoryDatableP
         (data: any): ScatterSymbolType;
     };
 }
-export declare const VictoryScatter: any;
+interface VictoryScatterBase extends EventsMixinClass<VictoryScatterProps> {
+}
+/**
+ * Draw area charts with React. VictoryArea is a composable component, so it doesn't include axes.
+ * Add VictoryArea as a child of VictoryChart for a complete chart.
+ */
+declare class VictoryScatterBase extends React.Component<VictoryScatterProps> {
+    static animationWhitelist: string[];
+    static displayName: string;
+    static role: string;
+    static defaultTransitions: import("victory-core").AnimatePropTypeInterface;
+    static propTypes: {
+        bubbleProperty: PropTypes.Requireable<string>;
+        maxBubbleSize: PropTypes.Requireable<number | undefined>;
+        minBubbleSize: PropTypes.Requireable<number | undefined>;
+        size: PropTypes.Requireable<number | ((...args: any[]) => any)>;
+        symbol: PropTypes.Requireable<string | ((...args: any[]) => any)>;
+        categories?: React.Validator<import("victory-core").CategoryPropType | null | undefined> | undefined;
+        data?: React.Validator<readonly any[] | null | undefined> | undefined;
+        dataComponent?: React.Validator<React.ReactElement<any, string | React.JSXElementConstructor<any>> | null | undefined> | undefined;
+        domain?: React.Validator<import("victory-core").ForAxes<import("victory-core").DomainTuple> | null | undefined> | undefined;
+        domainPadding?: React.Validator<import("victory-core").ForAxes<import("victory-core").PaddingType> | null | undefined> | undefined;
+        samples?: React.Validator<number | null | undefined> | undefined;
+        sortKey?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        sortOrder?: React.Validator<import("victory-core").SortOrderPropType | null | undefined> | undefined;
+        x?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        y?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        y0?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        theme?: React.Validator<import("victory-core").VictoryThemeDefinition | null | undefined> | undefined;
+        animate?: React.Validator<boolean | import("victory-core").AnimatePropTypeInterface | null | undefined> | undefined;
+        colorScale?: React.Validator<import("victory-core").ColorScalePropType | null | undefined> | undefined;
+        containerComponent?: React.Validator<React.ReactElement<any, string | React.JSXElementConstructor<any>> | null | undefined> | undefined;
+        externalEventMutations?: React.Validator<import("victory-core").EventCallbackInterface<string | string[], import("victory-core").StringOrNumberOrList>[] | null | undefined> | undefined;
+        groupComponent?: React.Validator<React.ReactElement<any, string | React.JSXElementConstructor<any>> | null | undefined> | undefined;
+        height?: React.Validator<number | null | undefined> | undefined;
+        horizontal?: React.Validator<boolean | null | undefined> | undefined;
+        maxDomain?: React.Validator<number | {
+            x?: number | undefined;
+            y?: number | undefined;
+        } | null | undefined> | undefined;
+        minDomain?: React.Validator<number | {
+            x?: number | undefined;
+            y?: number | undefined;
+        } | null | undefined> | undefined;
+        name?: React.Validator<string | null | undefined> | undefined;
+        origin?: React.Validator<import("victory-core").OriginType | null | undefined> | undefined;
+        padding?: React.Validator<import("victory-core").PaddingProps | null | undefined> | undefined;
+        polar?: React.Validator<boolean | null | undefined> | undefined;
+        range?: React.Validator<import("victory-core").ForAxes<import("victory-core").RangeTuple> | null | undefined> | undefined;
+        scale?: React.Validator<import("victory-core").D3Scale<any> | import("victory-core").ScaleName | {
+            x?: import("victory-core").D3Scale<any> | import("victory-core").ScaleName | undefined;
+            y?: import("victory-core").D3Scale<any> | import("victory-core").ScaleName | undefined;
+        } | null | undefined> | undefined;
+        sharedEvents?: React.Validator<{
+            events: any[];
+            getEventState: Function;
+        } | null | undefined> | undefined;
+        singleQuadrantDomainPadding?: React.Validator<boolean | {
+            x?: boolean | undefined;
+            y?: boolean | undefined;
+        } | null | undefined> | undefined;
+        standalone?: React.Validator<boolean | null | undefined> | undefined;
+        width?: React.Validator<number | null | undefined> | undefined;
+    };
+    static defaultProps: {
+        containerComponent: JSX.Element;
+        dataComponent: JSX.Element;
+        labelComponent: JSX.Element;
+        groupComponent: JSX.Element;
+        samples: number;
+        sortOrder: string;
+        standalone: boolean;
+        theme: import("victory-core").VictoryThemeDefinition;
+    };
+    static getDomain: typeof Domain.getDomain;
+    static getData: typeof Data.getData;
+    static getBaseProps: (props: any) => any;
+    static expectedComponents: string[];
+    shouldAnimate(): boolean;
+    render(): React.ReactElement;
+}
+export declare const VictoryScatter: {
+    new (props: import("victory-core").EventMixinCommonProps): {
+        state: {};
+        getEventState: (eventKey: string | number, namespace: string, childType?: string | undefined) => any;
+        getScopedEvents: (events: any, namespace: any, childType: any, baseProps: any) => {};
+        getEvents: (p: any, target: any, eventKey: any) => any;
+        externalMutations: {} | undefined;
+        calculatedState: {};
+        globalEvents: {};
+        prevGlobalEventKeys: string[];
+        boundGlobalEvents: {};
+        shouldComponentUpdate(nextProps: import("victory-core").EventMixinCommonProps): boolean;
+        componentDidMount(): void;
+        componentDidUpdate(prevProps: any): void;
+        componentWillUnmount(): void;
+        addGlobalListener(key: any): void;
+        removeGlobalListener(key: any): void;
+        getStateChanges(props: any): {};
+        applyExternalMutations(props: any, externalMutations: any): void;
+        getCalculatedValues(props: any): import("victory-core").EventMixinCalculatedValues;
+        getExternalMutations(props: import("victory-core").EventMixinCommonProps): {} | undefined;
+        cacheValues(obj: any): void;
+        getBaseProps(props: any, getSharedEventState: any): Record<string, object>;
+        getAllEvents(props: any): any;
+        getComponentProps(component: any, type: any, index: any): any;
+        renderContainer(component: any, children: any): React.DetailedReactHTMLElement<any, HTMLElement>;
+        animateComponent(props: import("victory-core").EventMixinCommonProps, defaultAnimationWhitelist: string[]): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+        renderContinuousData(props: import("victory-core").EventMixinCommonProps): React.DetailedReactHTMLElement<any, HTMLElement>;
+        renderData(props: any, shouldRenderDatum?: ((datum: any) => boolean) | undefined): React.DetailedReactHTMLElement<any, HTMLElement>;
+        context: unknown;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<import("victory-core").EventMixinCommonProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        render(): React.ReactNode;
+        readonly props: Readonly<import("victory-core").EventMixinCommonProps>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<import("victory-core").EventMixinCommonProps>, prevState: Readonly<{}>): any;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextState: Readonly<{}>, nextContext: any): void;
+        componentEvents: import("victory-core/lib/victory-util/events").ComponentEvent[];
+        getSharedEventState: (key: string, value: string) => unknown;
+        baseProps: Record<string, object>;
+        dataKeys: string[];
+        hasEvents: unknown;
+        events: unknown;
+    };
+    getBaseProps?(props: import("victory-core").EventMixinCommonProps): Record<string, object>;
+    role?: string | undefined;
+    expectedComponents?: string[] | undefined;
+    getChildren?: ((props: import("victory-core").EventMixinCommonProps, childComponents?: React.ReactNode[] | undefined, calculatedProps?: import("victory-core").EventMixinCommonProps | undefined) => void) | undefined;
+    animationWhitelist?: string[] | undefined;
+} & typeof VictoryScatterBase;
+export {};
 //# sourceMappingURL=victory-scatter.d.ts.map

package/lib/victory-scatter.d.ts

@@ -1,5 +1,6 @@
+import PropTypes from "prop-types";
 import React from "react";
-import { EventPropTypeInterface, ScatterSymbolType, StringOrNumberOrCallback, VictoryCommonProps, VictoryDatableProps, VictoryMultiLabelableProps, VictoryStyleInterface } from "victory-core";
+import { Data, Domain, EventPropTypeInterface, ScatterSymbolType, StringOrNumberOrCallback, EventsMixinClass, VictoryCommonProps, VictoryDatableProps, VictoryMultiLabelableProps, VictoryStyleInterface } from "victory-core";
 export declare type VictoryScatterTTargetType = "data" | "labels" | "parent";
 export interface VictoryScatterProps extends VictoryCommonProps, VictoryDatableProps, VictoryMultiLabelableProps {
     bubbleProperty?: string;
@@ -16,5 +17,144 @@ export interface VictoryScatterProps extends VictoryCommonProps, VictoryDatableP
         (data: any): ScatterSymbolType;
     };
 }
-export declare const VictoryScatter: any;
+interface VictoryScatterBase extends EventsMixinClass<VictoryScatterProps> {
+}
+/**
+ * Draw area charts with React. VictoryArea is a composable component, so it doesn't include axes.
+ * Add VictoryArea as a child of VictoryChart for a complete chart.
+ */
+declare class VictoryScatterBase extends React.Component<VictoryScatterProps> {
+    static animationWhitelist: string[];
+    static displayName: string;
+    static role: string;
+    static defaultTransitions: import("victory-core").AnimatePropTypeInterface;
+    static propTypes: {
+        bubbleProperty: PropTypes.Requireable<string>;
+        maxBubbleSize: PropTypes.Requireable<number | undefined>;
+        minBubbleSize: PropTypes.Requireable<number | undefined>;
+        size: PropTypes.Requireable<number | ((...args: any[]) => any)>;
+        symbol: PropTypes.Requireable<string | ((...args: any[]) => any)>;
+        categories?: React.Validator<import("victory-core").CategoryPropType | null | undefined> | undefined;
+        data?: React.Validator<readonly any[] | null | undefined> | undefined;
+        dataComponent?: React.Validator<React.ReactElement<any, string | React.JSXElementConstructor<any>> | null | undefined> | undefined;
+        domain?: React.Validator<import("victory-core").ForAxes<import("victory-core").DomainTuple> | null | undefined> | undefined;
+        domainPadding?: React.Validator<import("victory-core").ForAxes<import("victory-core").PaddingType> | null | undefined> | undefined;
+        samples?: React.Validator<number | null | undefined> | undefined;
+        sortKey?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        sortOrder?: React.Validator<import("victory-core").SortOrderPropType | null | undefined> | undefined;
+        x?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        y?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        y0?: React.Validator<import("victory-core").DataGetterPropType | null | undefined> | undefined;
+        theme?: React.Validator<import("victory-core").VictoryThemeDefinition | null | undefined> | undefined;
+        animate?: React.Validator<boolean | import("victory-core").AnimatePropTypeInterface | null | undefined> | undefined;
+        colorScale?: React.Validator<import("victory-core").ColorScalePropType | null | undefined> | undefined;
+        containerComponent?: React.Validator<React.ReactElement<any, string | React.JSXElementConstructor<any>> | null | undefined> | undefined;
+        externalEventMutations?: React.Validator<import("victory-core").EventCallbackInterface<string | string[], import("victory-core").StringOrNumberOrList>[] | null | undefined> | undefined;
+        groupComponent?: React.Validator<React.ReactElement<any, string | React.JSXElementConstructor<any>> | null | undefined> | undefined;
+        height?: React.Validator<number | null | undefined> | undefined;
+        horizontal?: React.Validator<boolean | null | undefined> | undefined;
+        maxDomain?: React.Validator<number | {
+            x?: number | undefined;
+            y?: number | undefined;
+        } | null | undefined> | undefined;
+        minDomain?: React.Validator<number | {
+            x?: number | undefined;
+            y?: number | undefined;
+        } | null | undefined> | undefined;
+        name?: React.Validator<string | null | undefined> | undefined;
+        origin?: React.Validator<import("victory-core").OriginType | null | undefined> | undefined;
+        padding?: React.Validator<import("victory-core").PaddingProps | null | undefined> | undefined;
+        polar?: React.Validator<boolean | null | undefined> | undefined;
+        range?: React.Validator<import("victory-core").ForAxes<import("victory-core").RangeTuple> | null | undefined> | undefined;
+        scale?: React.Validator<import("victory-core").D3Scale<any> | import("victory-core").ScaleName | {
+            x?: import("victory-core").D3Scale<any> | import("victory-core").ScaleName | undefined;
+            y?: import("victory-core").D3Scale<any> | import("victory-core").ScaleName | undefined;
+        } | null | undefined> | undefined;
+        sharedEvents?: React.Validator<{
+            events: any[];
+            getEventState: Function;
+        } | null | undefined> | undefined;
+        singleQuadrantDomainPadding?: React.Validator<boolean | {
+            x?: boolean | undefined;
+            y?: boolean | undefined;
+        } | null | undefined> | undefined;
+        standalone?: React.Validator<boolean | null | undefined> | undefined;
+        width?: React.Validator<number | null | undefined> | undefined;
+    };
+    static defaultProps: {
+        containerComponent: JSX.Element;
+        dataComponent: JSX.Element;
+        labelComponent: JSX.Element;
+        groupComponent: JSX.Element;
+        samples: number;
+        sortOrder: string;
+        standalone: boolean;
+        theme: import("victory-core").VictoryThemeDefinition;
+    };
+    static getDomain: typeof Domain.getDomain;
+    static getData: typeof Data.getData;
+    static getBaseProps: (props: any) => any;
+    static expectedComponents: string[];
+    shouldAnimate(): boolean;
+    render(): React.ReactElement;
+}
+export declare const VictoryScatter: {
+    new (props: import("victory-core").EventMixinCommonProps): {
+        state: {};
+        getEventState: (eventKey: string | number, namespace: string, childType?: string | undefined) => any;
+        getScopedEvents: (events: any, namespace: any, childType: any, baseProps: any) => {};
+        getEvents: (p: any, target: any, eventKey: any) => any;
+        externalMutations: {} | undefined;
+        calculatedState: {};
+        globalEvents: {};
+        prevGlobalEventKeys: string[];
+        boundGlobalEvents: {};
+        shouldComponentUpdate(nextProps: import("victory-core").EventMixinCommonProps): boolean;
+        componentDidMount(): void;
+        componentDidUpdate(prevProps: any): void;
+        componentWillUnmount(): void;
+        addGlobalListener(key: any): void;
+        removeGlobalListener(key: any): void;
+        getStateChanges(props: any): {};
+        applyExternalMutations(props: any, externalMutations: any): void;
+        getCalculatedValues(props: any): import("victory-core").EventMixinCalculatedValues;
+        getExternalMutations(props: import("victory-core").EventMixinCommonProps): {} | undefined;
+        cacheValues(obj: any): void;
+        getBaseProps(props: any, getSharedEventState: any): Record<string, object>;
+        getAllEvents(props: any): any;
+        getComponentProps(component: any, type: any, index: any): any;
+        renderContainer(component: any, children: any): React.DetailedReactHTMLElement<any, HTMLElement>;
+        animateComponent(props: import("victory-core").EventMixinCommonProps, defaultAnimationWhitelist: string[]): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+        renderContinuousData(props: import("victory-core").EventMixinCommonProps): React.DetailedReactHTMLElement<any, HTMLElement>;
+        renderData(props: any, shouldRenderDatum?: ((datum: any) => boolean) | undefined): React.DetailedReactHTMLElement<any, HTMLElement>;
+        context: unknown;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<import("victory-core").EventMixinCommonProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        render(): React.ReactNode;
+        readonly props: Readonly<import("victory-core").EventMixinCommonProps>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<import("victory-core").EventMixinCommonProps>, prevState: Readonly<{}>): any;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<import("victory-core").EventMixinCommonProps>, nextState: Readonly<{}>, nextContext: any): void;
+        componentEvents: import("victory-core/lib/victory-util/events").ComponentEvent[];
+        getSharedEventState: (key: string, value: string) => unknown;
+        baseProps: Record<string, object>;
+        dataKeys: string[];
+        hasEvents: unknown;
+        events: unknown;
+    };
+    getBaseProps?(props: import("victory-core").EventMixinCommonProps): Record<string, object>;
+    role?: string | undefined;
+    expectedComponents?: string[] | undefined;
+    getChildren?: ((props: import("victory-core").EventMixinCommonProps, childComponents?: React.ReactNode[] | undefined, calculatedProps?: import("victory-core").EventMixinCommonProps | undefined) => void) | undefined;
+    animationWhitelist?: string[] | undefined;
+} & typeof VictoryScatterBase;
+export {};
 //# sourceMappingURL=victory-scatter.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "victory-scatter",
-  "version": "36.6.0",
+  "version": "36.6.1",
   "description": "Scatter Component for Victory",
   "keywords": [
     "data visualization",
@@ -22,7 +22,7 @@
   "dependencies": {
     "lodash": "^4.17.19",
     "prop-types": "^15.8.1",
-    "victory-core": "^36.6.0"
+    "victory-core": "^36.6.1"
   },
   "peerDependencies": {
     "react": ">=16.6.0"
@@ -126,6 +126,14 @@
         "pnpm-lock.yaml"
       ]
     },
+    "check": {
+      "dependencies": [
+        "types:check",
+        "jest",
+        "format",
+        "lint"
+      ]
+    },
     "types:check": {
       "command": "nps types:pkg:check",
       "files": [
@@ -178,6 +186,19 @@
         "pnpm-lock.yaml"
       ]
     },
+    "format:fix": {
+      "command": "pnpm run format || nps format:pkg:fix",
+      "files": [
+        "src/**",
+        "*.json",
+        "../../.prettierignore",
+        "../../.prettierrc.json"
+      ],
+      "output": [],
+      "packageLocks": [
+        "pnpm-lock.yaml"
+      ]
+    },
     "lint": {
       "command": "nps lint:pkg",
       "files": [
@@ -195,19 +216,6 @@
         "pnpm-lock.yaml"
       ]
     },
-    "format:fix": {
-      "command": "pnpm run format || nps format:pkg:fix",
-      "files": [
-        "src/**",
-        "*.json",
-        "../../.prettierignore",
-        "../../.prettierrc.json"
-      ],
-      "output": [],
-      "packageLocks": [
-        "pnpm-lock.yaml"
-      ]
-    },
     "lint:fix": {
       "command": "pnpm run lint || nps lint:pkg:fix",
       "files": [
@@ -254,6 +262,7 @@
     "build:dist": "wireit",
     "build:dist:dev": "wireit",
     "build:dist:min": "wireit",
+    "check": "wireit",
     "types:check": "wireit",
     "types:create": "wireit",
     "format": "wireit",

package/src/victory-scatter.tsx

@@ -125,7 +125,7 @@ class VictoryScatterBase extends React.Component<VictoryScatterProps> {
     return !!this.props.animate;
   }
 
-  render() {
+  render(): React.ReactElement {
     const { animationWhitelist, role } = VictoryScatter;
     const props = Helpers.modifyProps(this.props, fallbackProps, role);