Merge pull request #3748 from ag-grid/imoses/deprecated-validate-decorator

Set TempValidator in series & axes properties to flush out missing validations

Author: alantreadway

packages/ag-charts-community/src/chart/axis/axis.ts

@@ -31,7 +31,7 @@ import { createId } from '../../util/id';
 import { findMinMax, findRangeExtent } from '../../util/number';
 import { mergeDefaults } from '../../util/object';
 import { ObserveChanges } from '../../util/proxy';
-import { BOOLEAN, OBJECT, STRING_ARRAY, Validate } from '../../util/validation';
+import { BOOLEAN, OBJECT, STRING_ARRAY, TempValidate } from '../../util/validation';
 import { Caption } from '../caption';
 import type { ChartAnimationPhase } from '../chartAnimationPhase';
 import type { AxisGroups, ChartAxis, ChartAxisLabelFlipFlag } from '../chartAxis';
@@ -107,17 +107,17 @@ export abstract class Axis<
     // user pass-through option: no validation required.
     context?: unknown;
 
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     nice: boolean = true;
 
     /** Reverse the axis scale domain. */
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     reverse: boolean = false;
 
-    @Validate(STRING_ARRAY)
+    @TempValidate(STRING_ARRAY)
     keys: string[] = [];
 
-    @Validate(OBJECT)
+    @TempValidate(OBJECT)
     readonly interval = new AxisInterval();
 
     dataDomain: { domain: D[]; clipped: boolean } = { domain: [], clipped: false };
@@ -339,7 +339,7 @@ export abstract class Axis<
         return formatValue(datum, fractionDigits);
     }
 
-    @Validate(OBJECT)
+    @TempValidate(OBJECT)
     readonly title = new AxisTitle();
 
     /**

packages/ag-charts-community/src/chart/axis/axisGridLine.ts

@@ -1,7 +1,7 @@
 import { isObject } from 'ag-charts-core';
 import type { AgAxisGridStyle } from 'ag-charts-types';
 
-import { ARRAY_OF, BOOLEAN, POSITIVE_NUMBER, Validate } from '../../util/validation';
+import { ARRAY_OF, BOOLEAN, POSITIVE_NUMBER, TempValidate } from '../../util/validation';
 
 const GRID_STYLE_KEYS = ['stroke', 'lineDash'];
 const GRID_STYLE = ARRAY_OF(
@@ -10,13 +10,13 @@ const GRID_STYLE = ARRAY_OF(
 );
 
 export class AxisGridLine {
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     enabled = true;
 
-    @Validate(POSITIVE_NUMBER)
+    @TempValidate(POSITIVE_NUMBER)
     width: number = 1;
 
-    @Validate(GRID_STYLE)
+    @TempValidate(GRID_STYLE)
     style: AgAxisGridStyle[] = [
         {
             stroke: undefined,

packages/ag-charts-community/src/chart/axis/axisInterval.ts

@@ -3,7 +3,7 @@ import { isFiniteNumber } from 'ag-charts-core';
 import { Default } from '../../util/default';
 import { BaseProperties } from '../../util/properties';
 import { TimeInterval } from '../../util/time';
-import { ARRAY, MAX_SPACING, MIN_SPACING, Validate, predicateWithMessage } from '../../util/validation';
+import { ARRAY, MAX_SPACING, MIN_SPACING, TempValidate, predicateWithMessage } from '../../util/validation';
 import type { TickInterval } from './axisTick';
 
 export const TICK_INTERVAL = predicateWithMessage(
@@ -12,17 +12,17 @@ export const TICK_INTERVAL = predicateWithMessage(
 );
 
 export class AxisInterval<S> extends BaseProperties {
-    @Validate(TICK_INTERVAL, { optional: true })
+    @TempValidate(TICK_INTERVAL, { optional: true })
     step?: TickInterval<S>;
 
-    @Validate(ARRAY, { optional: true })
+    @TempValidate(ARRAY, { optional: true })
     values?: any[];
 
-    @Validate(MIN_SPACING)
+    @TempValidate(MIN_SPACING)
     @Default(NaN)
     minSpacing: number = NaN;
 
-    @Validate(MAX_SPACING)
+    @TempValidate(MAX_SPACING)
     @Default(NaN)
     maxSpacing: number = NaN;
 }

packages/ag-charts-community/src/chart/axis/axisLabel.ts

@@ -21,44 +21,44 @@ import {
     NUMBER_OR_NAN,
     POSITIVE_NUMBER,
     STRING,
-    Validate,
+    TempValidate,
 } from '../../util/validation';
 import type { ChartAxisLabel, ChartAxisLabelFlipFlag } from '../chartAxis';
 
 export class AxisLabel extends BaseProperties implements ChartAxisLabel {
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     enabled = true;
 
-    @Validate(FONT_STYLE, { optional: true })
+    @TempValidate(FONT_STYLE, { optional: true })
     fontStyle?: FontStyle;
 
-    @Validate(FONT_WEIGHT, { optional: true })
+    @TempValidate(FONT_WEIGHT, { optional: true })
     fontWeight?: FontWeight;
 
-    @Validate(NUMBER.restrict({ min: 1 }))
+    @TempValidate(NUMBER.restrict({ min: 1 }))
     fontSize!: number;
 
-    @Validate(STRING)
+    @TempValidate(STRING)
     fontFamily!: string;
 
     /**
      * The padding between the labels and the ticks.
      */
-    @Validate(POSITIVE_NUMBER)
+    @TempValidate(POSITIVE_NUMBER)
     spacing: number = 5;
 
     /**
      * Minimum gap in pixels between the axis labels before being removed to avoid collisions.
      */
-    @Validate(NUMBER_OR_NAN)
+    @TempValidate(NUMBER_OR_NAN)
     @Default(NaN)
     minSpacing: number = NaN;
 
     /**
      * The color of the labels.
      * Use `undefined` rather than `rgba(0, 0, 0, 0)` to make labels invisible.
      */
-    @Validate(COLOR_STRING, { optional: true })
+    @TempValidate(COLOR_STRING, { optional: true })
     color?: string = '#575757';
 
     /**
@@ -68,13 +68,13 @@ export class AxisLabel extends BaseProperties implements ChartAxisLabel {
      * The value of this config is used as the angular offset/deflection
      * from the default rotation.
      */
-    @Validate(NUMBER, { optional: true })
+    @TempValidate(NUMBER, { optional: true })
     rotation?: number;
 
     /**
      * Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide.
      */
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     avoidCollisions: boolean = true;
 
     /**
@@ -90,7 +90,7 @@ export class AxisLabel extends BaseProperties implements ChartAxisLabel {
      * from north-west to south-east, _starting_ at the tick to the right
      * of the axis line.
      */
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     mirrored: boolean = false;
 
     /**
@@ -107,10 +107,10 @@ export class AxisLabel extends BaseProperties implements ChartAxisLabel {
      * Setting this config to `true` makes labels render parallel to the axis line
      * and center aligns labels' text at the ticks.
      */
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     parallel: boolean = false;
 
-    @Validate(FUNCTION, { optional: true })
+    @TempValidate(FUNCTION, { optional: true })
     itemStyler?: Styler<AgAxisLabelStylerParams, AgBaseAxisLabelStyleOptions>;
 
     /**
@@ -119,10 +119,10 @@ export class AxisLabel extends BaseProperties implements ChartAxisLabel {
      * digits used by the tick step. For example, if the tick step is `0.0005`,
      * the `fractionDigits` is 4.
      */
-    @Validate(FUNCTION, { optional: true })
+    @TempValidate(FUNCTION, { optional: true })
     formatter?: Formatter<AgAxisLabelFormatterParams>;
 
-    @Validate(STRING, { optional: true })
+    @TempValidate(STRING, { optional: true })
     format?: string;
 
     getFont(): string {

packages/ag-charts-community/src/chart/axis/axisLine.ts

@@ -1,12 +1,12 @@
-import { BOOLEAN, COLOR_STRING, POSITIVE_NUMBER, Validate } from '../../util/validation';
+import { BOOLEAN, COLOR_STRING, POSITIVE_NUMBER, TempValidate } from '../../util/validation';
 
 export class AxisLine {
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     enabled = true;
 
-    @Validate(POSITIVE_NUMBER)
+    @TempValidate(POSITIVE_NUMBER)
     width: number = 1;
 
-    @Validate(COLOR_STRING, { optional: true })
+    @TempValidate(COLOR_STRING, { optional: true })
     stroke?: string = undefined;
 }

packages/ag-charts-community/src/chart/axis/axisTick.ts

@@ -2,23 +2,23 @@ import type { OrdinalTimeScale } from '../../scale/ordinalTimeScale';
 import type { TimeScale } from '../../scale/timeScale';
 import { BaseProperties } from '../../util/properties';
 import { TimeInterval } from '../../util/time';
-import { BOOLEAN, COLOR_STRING, POSITIVE_NUMBER, Validate } from '../../util/validation';
+import { BOOLEAN, COLOR_STRING, POSITIVE_NUMBER, TempValidate } from '../../util/validation';
 
 export type TickInterval<S> = S extends TimeScale | OrdinalTimeScale ? number | TimeInterval : number;
 
 export class AxisTick extends BaseProperties {
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     enabled = true;
 
     /** The line width to be used by axis ticks. */
-    @Validate(POSITIVE_NUMBER)
+    @TempValidate(POSITIVE_NUMBER)
     width: number = 1;
 
     /** The line length to be used by axis ticks. */
-    @Validate(POSITIVE_NUMBER)
+    @TempValidate(POSITIVE_NUMBER)
     size: number = 6;
 
     /** The color of the axis ticks. */
-    @Validate(COLOR_STRING, { optional: true })
+    @TempValidate(COLOR_STRING, { optional: true })
     stroke?: string;
 }

packages/ag-charts-community/src/chart/axis/axisTitle.ts

@@ -17,40 +17,40 @@ import {
     POSITIVE_NUMBER,
     STRING,
     TEXT_WRAP,
-    Validate,
+    TempValidate,
 } from '../../util/validation';
 import { Caption } from '../caption';
 
 export class AxisTitle extends BaseProperties implements AgAxisCaptionOptions {
     readonly caption = new Caption();
 
-    @Validate(BOOLEAN)
+    @TempValidate(BOOLEAN)
     enabled: boolean = false;
 
-    @Validate(STRING, { optional: true })
+    @TempValidate(STRING, { optional: true })
     text?: string;
 
-    @Validate(POSITIVE_NUMBER, { optional: true })
+    @TempValidate(POSITIVE_NUMBER, { optional: true })
     spacing?: number = Caption.SMALL_PADDING;
 
-    @Validate(FONT_STYLE, { optional: true })
+    @TempValidate(FONT_STYLE, { optional: true })
     fontStyle?: FontStyle;
 
-    @Validate(FONT_WEIGHT, { optional: true })
+    @TempValidate(FONT_WEIGHT, { optional: true })
     fontWeight?: FontWeight;
 
-    @Validate(POSITIVE_NUMBER)
+    @TempValidate(POSITIVE_NUMBER)
     fontSize: number = 10;
 
-    @Validate(STRING)
+    @TempValidate(STRING)
     fontFamily: string = 'sans-serif';
 
-    @Validate(COLOR_STRING, { optional: true })
+    @TempValidate(COLOR_STRING, { optional: true })
     color?: string;
 
-    @Validate(TEXT_WRAP)
+    @TempValidate(TEXT_WRAP)
     wrapping: TextWrap = 'always';
 
-    @Validate(FUNCTION, { optional: true })
+    @TempValidate(FUNCTION, { optional: true })
     formatter?: Formatter<AgAxisCaptionFormatterParams>;
 }

packages/ag-charts-community/src/chart/axis/cartesianAxis.ts

@@ -10,7 +10,7 @@ import { BBox } from '../../scene/bbox';
 import { Group } from '../../scene/group';
 import { TransformableText } from '../../scene/shape/text';
 import { StateMachine } from '../../util/stateMachine';
-import { POSITION, POSITIVE_NUMBER, Validate } from '../../util/validation';
+import { POSITION, POSITIVE_NUMBER, TempValidate } from '../../util/validation';
 import { Caption } from '../caption';
 import type { ChartAnimationPhase } from '../chartAnimationPhase';
 import { ChartAxisDirection } from '../chartAxisDirection';
@@ -46,10 +46,10 @@ export abstract class CartesianAxis<S extends Scale<D, number, any> = Scale<any,
         return value instanceof CartesianAxis;
     }
 
-    @Validate(POSITIVE_NUMBER, { optional: true })
+    @TempValidate(POSITIVE_NUMBER, { optional: true })
     thickness?: number;
 
-    @Validate(POSITION)
+    @TempValidate(POSITION)
     position!: AgCartesianAxisPosition;
 
     protected animationManager: AnimationManager;

packages/ag-charts-community/src/chart/axis/cartesianAxisLabel.ts

@@ -1,17 +1,17 @@
-import { BOOLEAN, NUMBER, Validate } from '../../util/validation';
+import { BOOLEAN, NUMBER, TempValidate } from '../../util/validation';
 import { AxisLabel } from './axisLabel';
 
 export class CartesianAxisLabel extends AxisLabel {
     /**
      * If specified and axis labels may collide, they are rotated to reduce collisions. If the
      * `rotation` property is specified, it takes precedence.
      */
-    @Validate(BOOLEAN, { optional: true })
+    @TempValidate(BOOLEAN, { optional: true })
     autoRotate?: boolean;
 
     /**
      * Rotation angle to use when autoRotate is applied.
      */
-    @Validate(NUMBER)
+    @TempValidate(NUMBER)
     autoRotateAngle: number = 335;
 }

packages/ag-charts-community/src/chart/axis/categoryAxis.ts

@@ -3,7 +3,7 @@ import { isFiniteNumber } from 'ag-charts-core';
 import type { ModuleContext } from '../../module/moduleContext';
 import { CategoryScale } from '../../scale/categoryScale';
 import type { OrdinalTimeScale } from '../../scale/ordinalTimeScale';
-import { RATIO, Validate } from '../../util/validation';
+import { RATIO, TempValidate } from '../../util/validation';
 import { CartesianAxis } from './cartesianAxis';
 
 export class CategoryAxis<
@@ -24,13 +24,13 @@ export class CategoryAxis<
         this.nice = false;
     }
 
-    @Validate(RATIO)
+    @TempValidate(RATIO)
     groupPaddingInner: number = 0.1;
 
-    @Validate(RATIO, { optional: true })
+    @TempValidate(RATIO, { optional: true })
     paddingInner?: number;
 
-    @Validate(RATIO, { optional: true })
+    @TempValidate(RATIO, { optional: true })
     paddingOuter?: number;
 
     override normaliseDataDomain(domain: Array<string | object>) {