refactor(D3 plugin): add dict for widget types (#373)

gravity-ui · Dec 28, 2023 · 54633c1 · 54633c1
1 parent 5a8dab7
commit 54633c1
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 15 deletions.
diff --git a/src/constants/widget-data.ts b/src/constants/widget-data.ts
@@ -1,3 +1,12 @@
+export const WidgetType = {
+    Area: 'area',
+    BarX: 'bar-x',
+    BarY: 'bar-y',
+    Line: 'line',
+    Pie: 'pie',
+    Scatter: 'scatter',
+} as const;
+
 export enum DashStyle {
     Dash = 'Dash',
     DashDot = 'DashDot',

diff --git a/src/plugins/d3/renderer/validation/index.ts b/src/plugins/d3/renderer/validation/index.ts
@@ -1,5 +1,7 @@
 import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
+
+import {WidgetType} from '../../../../constants';
 import {ChartKitError, CHARTKIT_ERROR_CODE} from '../../../../libs';
 import {
     BarXSeries,
@@ -12,18 +14,12 @@ import {
     ScatterSeries,
 } from '../../../../types';
 import {i18n} from '../../../../i18n';
+
 import {DEFAULT_AXIS_TYPE} from '../constants';
 
 type XYSeries = ScatterSeries | BarXSeries | BarYSeries | LineSeries;
 
-const AVAILABLE_SERIES_TYPES: ChartKitWidgetSeries['type'][] = [
-    'area',
-    'bar-x',
-    'bar-y',
-    'line',
-    'pie',
-    'scatter',
-];
+const AVAILABLE_SERIES_TYPES = Object.values(WidgetType);
 
 const validateXYSeries = (args: {
     series: XYSeries;

diff --git a/src/types/widget-data/area.ts b/src/types/widget-data/area.ts
@@ -1,3 +1,4 @@
+import {WidgetType} from '../../constants';
 import type {BaseSeries, BaseSeriesData} from './base';
 import type {ChartKitWidgetLegend, RectLegendSymbolOptions} from './legend';
 import type {PointMarkerOptions} from './marker';
@@ -28,7 +29,7 @@ export type AreaMarkerOptions = PointMarkerOptions & {
 };
 
 export type AreaSeries<T = any> = BaseSeries & {
-    type: 'area';
+    type: typeof WidgetType.Area;
     data: AreaSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
     name: string;

diff --git a/src/types/widget-data/bar-x.ts b/src/types/widget-data/bar-x.ts
@@ -1,3 +1,4 @@
+import {WidgetType} from '../../constants';
 import type {BaseSeries, BaseSeriesData} from './base';
 import type {ChartKitWidgetSeriesOptions} from './series';
 import {ChartKitWidgetLegend, RectLegendSymbolOptions} from './legend';
@@ -28,7 +29,7 @@ export type BarXSeriesData<T = any> = BaseSeriesData<T> & {
 };
 
 export type BarXSeries<T = any> = BaseSeries & {
-    type: 'bar-x';
+    type: typeof WidgetType.BarX;
     data: BarXSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
     name: string;

diff --git a/src/types/widget-data/bar-y.ts b/src/types/widget-data/bar-y.ts
@@ -1,3 +1,4 @@
+import {WidgetType} from '../../constants';
 import type {BaseSeries, BaseSeriesData} from './base';
 import type {ChartKitWidgetSeriesOptions} from './series';
 import {ChartKitWidgetLegend, RectLegendSymbolOptions} from './legend';
@@ -22,7 +23,7 @@ export type BarYSeriesData<T = any> = BaseSeriesData<T> & {
 };
 
 export type BarYSeries<T = any> = BaseSeries & {
-    type: 'bar-y';
+    type: typeof WidgetType.BarY;
     data: BarYSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
     name: string;

diff --git a/src/types/widget-data/line.ts b/src/types/widget-data/line.ts
@@ -1,7 +1,7 @@
 import type {BaseSeries, BaseSeriesData} from './base';
 import type {ChartKitWidgetLegend, RectLegendSymbolOptions} from './legend';
 import type {PointMarkerOptions} from './marker';
-import {DashStyle, LineCap} from '../../constants';
+import {DashStyle, LineCap, WidgetType} from '../../constants';
 
 export type LineSeriesData<T = any> = BaseSeriesData<T> & {
     /**
@@ -29,7 +29,7 @@ export type LineMarkerOptions = PointMarkerOptions & {
 };
 
 export type LineSeries<T = any> = BaseSeries & {
-    type: 'line';
+    type: typeof WidgetType.Line;
     data: LineSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
     name: string;

diff --git a/src/types/widget-data/pie.ts b/src/types/widget-data/pie.ts
@@ -1,3 +1,4 @@
+import {WidgetType} from '../../constants';
 import type {BaseSeries, BaseSeriesData} from './base';
 import {ChartKitWidgetLegend, RectLegendSymbolOptions} from './legend';
 
@@ -16,7 +17,7 @@ export type ConnectorShape = 'straight-line' | 'polyline';
 export type ConnectorCurve = 'linear' | 'basic';
 
 export type PieSeries<T = any> = BaseSeries & {
-    type: 'pie';
+    type: typeof WidgetType.Pie;
     data: PieSeriesData<T>[];
     /**
      * The color of the border surrounding each segment.

diff --git a/src/types/widget-data/scatter.ts b/src/types/widget-data/scatter.ts
@@ -1,3 +1,4 @@
+import {WidgetType} from '../../constants';
 import type {BaseSeries, BaseSeriesData} from './base';
 import type {ChartKitWidgetLegend, RectLegendSymbolOptions} from './legend';
 
@@ -26,7 +27,7 @@ export type ScatterSeriesData<T = any> = BaseSeriesData<T> & {
 };
 
 export type ScatterSeries<T = any> = BaseSeries & {
-    type: 'scatter';
+    type: typeof WidgetType.Scatter;
     data: ScatterSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
     name: string;