feat: types improvements

src/components/ChartKit.tsx

@@ -3,7 +3,7 @@ import block from 'bem-cn-lite';
 import {i18n} from '../i18n';
 import {CHARTKIT_ERROR_CODE, ChartKitError, settings} from '../libs';
 import {getRandomCKId, typedMemo} from '../utils';
-import type {ChartkitType, ChartKitRef, ChartKitWidgetRef, ChartKitProps} from '../types';
+import type {ChartKitType, ChartKitRef, ChartKitWidgetRef, ChartKitProps} from '../types';
 import {ErrorBoundary} from './ErrorBoundary/ErrorBoundary';
 import {Loader} from './Loader/Loader';
 
@@ -12,11 +12,11 @@ import './ChartKit.scss';
 
 const b = block('chartkit');
 
-type ChartKitComponentProps<T extends ChartkitType> = Omit<ChartKitProps<T>, 'onError'> & {
+type ChartKitComponentProps<T extends ChartKitType> = Omit<ChartKitProps<T>, 'onError'> & {
     instanceRef?: React.ForwardedRef<ChartKitRef | undefined>;
 };
 
-const ChartKitComponent = <T extends ChartkitType>(props: ChartKitComponentProps<T>) => {
+const ChartKitComponent = <T extends ChartKitType>(props: ChartKitComponentProps<T>) => {
     const widgetRef = React.useRef<ChartKitWidgetRef>();
     const {instanceRef, id = getRandomCKId(), type, data, onLoad, isMobile, ...restProps} = props;
     const lang = settings.get('lang');
@@ -62,14 +62,14 @@ const ChartKitComponent = <T extends ChartkitType>(props: ChartKitComponentProps
 
 const ChartKitComponentWithErrorBoundary = React.forwardRef<
     ChartKitRef | undefined,
-    ChartKitProps<ChartkitType>
+    ChartKitProps<ChartKitType>
 >(function ChartKitComponentWithErrorBoundary(props, ref) {
     return (
         <ErrorBoundary onError={props.onError}>
             <ChartKitComponent instanceRef={ref} {...props} />
         </ErrorBoundary>
     );
-}) /* https://stackoverflow.com/a/58473012 */ as <T extends ChartkitType>(
+}) /* https://stackoverflow.com/a/58473012 */ as <T extends ChartKitType>(
     props: ChartKitProps<T> & {ref?: React.ForwardedRef<ChartKitRef | undefined>},
 ) => ReturnType<typeof ChartKitComponent>;
 

src/index.ts

@@ -9,8 +9,8 @@ export type {
     ChartKitProps,
     ChartKitRef,
     ChartKitWidgetRef,
-    ChartkitType,
-    ChartkitWidget,
+    ChartKitType,
+    ChartKitWidget,
 } from './types';
 
 export {settings};

src/plugins/highcharts/renderer/helpers/graph.ts

@@ -2,7 +2,7 @@ import type {ChartKitHolidays} from '../../../../types';
 import type {
     Highcharts,
     HighchartsWidgetData,
-    ChartKitComment,
+    HighchartsComment,
     ExtendedHChart,
     XAxisItem,
 } from '../../types';
@@ -18,7 +18,7 @@ import './graph.scss';
 type GetGraphArgs = {
     options: ConfigOptions;
     data: HighchartsWidgetData['data'];
-    comments?: ChartKitComment[];
+    comments?: HighchartsComment[];
     holidays?: ChartKitHolidays;
     isMobile?: boolean;
 };

src/plugins/highcharts/types/comments.ts

@@ -52,4 +52,4 @@ interface CommentFlagX extends CommentBase {
     };
 }
 
-export type ChartKitComment = CommentDotXY | CommentBandX | CommentLineX | CommentFlagX;
+export type HighchartsComment = CommentDotXY | CommentBandX | CommentLineX | CommentFlagX;

src/plugins/highcharts/types/index.ts

@@ -1,4 +1,4 @@
 export type {Highcharts} from './lib';
 export type {HighchartsWidgetData} from './widget';
 export type {DrillDownConfig, ExtendedHChart, StringParams, XAxisItem} from './misc';
-export type {ChartKitComment} from './comments';
+export type {HighchartsComment} from './comments';

src/plugins/highcharts/types/misc.ts

@@ -1,4 +1,4 @@
-import type {ChartKitComment} from './comments';
+import type {HighchartsComment} from './comments';
 
 export type StringParams = Record<string, string | string[]>;
 
@@ -14,9 +14,9 @@ export type XAxisItem = Highcharts.Axis & {
 
 export type ExtendedHChart = Highcharts.Chart & {
     userOptions: Highcharts.Options & {
-        _internalComments: ChartKitComment[];
-        _externalComments: ChartKitComment[];
-        _getComments: () => ChartKitComment[];
+        _internalComments: HighchartsComment[];
+        _externalComments: HighchartsComment[];
+        _getComments: () => HighchartsComment[];
     };
     xAxis: XAxisItem[];
     navigator?: Highcharts.Options['navigator'];

src/plugins/highcharts/types/widget.ts

@@ -1,5 +1,5 @@
 import type {Highcharts} from './lib';
-import type {ChartKitComment} from './comments';
+import type {HighchartsComment} from './comments';
 import type {DrillDownConfig, StringParams} from './misc';
 
 type GraphWidgetSeriesOptions = Highcharts.SeriesOptionsType & {
@@ -22,7 +22,7 @@ export type HighchartsWidgetData = {
         | {
               graphs: GraphWidgetSeriesOptions[];
           }
-    ) & {comments?: ChartKitComment[]};
+    ) & {comments?: HighchartsComment[]};
     config: {
         hideComments?: boolean;
         hideHolidaysBands?: boolean;
@@ -46,6 +46,6 @@ export type HighchartsWidgetData = {
     };
     libraryConfig: Highcharts.Options;
     params?: StringParams;
-    comments?: ChartKitComment[];
+    comments?: HighchartsComment[];
     sideMarkdown?: string;
 };

src/plugins/index.ts

@@ -3,4 +3,4 @@ export type {Yagr, YagrWidgetData} from './yagr/types';
 export {IndicatorPlugin} from './indicator';
 export type {IndicatorWidgetData} from './indicator/types';
 export {HighchartsPlugin} from './highcharts';
-export type {Highcharts, HighchartsWidgetData} from './highcharts/types';
+export type {Highcharts, HighchartsWidgetData, HighchartsComment} from './highcharts/types';

src/types/index.ts

@@ -1,10 +1,10 @@
-import type {ChartkitWidget} from './widget';
+import type {ChartKitWidget} from './widget';
 
 export type {ChartKitHolidays} from './misc';
 
 export type ChartKitLang = 'ru' | 'en';
 
-export type ChartkitType = keyof ChartkitWidget;
+export type ChartKitType = keyof ChartKitWidget;
 
 export type ChartKitRef = {
     reflow: (details?: unknown) => void;
@@ -14,25 +14,25 @@ export type ChartKitWidgetRef = {
     reflow?: ChartKitRef['reflow'];
 };
 
-export type ChartKitOnLoadData<T extends ChartkitType> = {
-    widget?: ChartkitWidget[T]['widget'];
+export type ChartKitOnLoadData<T extends ChartKitType> = {
+    widget?: ChartKitWidget[T]['widget'];
     widgetRendering?: number;
 };
 
 export type ChartKitOnError = (data: {error: any}) => void;
 
-export type ChartKitProps<T extends ChartkitType> = {
+export type ChartKitProps<T extends ChartKitType> = {
     type: T;
-    data: ChartkitWidget[T]['data'];
+    data: ChartKitWidget[T]['data'];
     id?: string;
     isMobile?: boolean;
     onLoad?: (data?: ChartKitOnLoadData<T>) => void;
     onError?: ChartKitOnError;
-} & {[key in keyof Omit<ChartkitWidget[T], 'data' | 'widget'>]: ChartkitWidget[T][key]};
+} & {[key in keyof Omit<ChartKitWidget[T], 'data' | 'widget'>]: ChartKitWidget[T][key]};
 
 export type ChartKitPlugin = {
-    type: ChartkitType;
+    type: ChartKitType;
     renderer: React.LazyExoticComponent<any>;
 };
 
-export type {ChartkitWidget};
+export type {ChartKitWidget};

src/types/widget.ts

@@ -3,7 +3,7 @@ import type {YagrWidgetData} from '../plugins/yagr/types';
 import type {IndicatorWidgetData} from '../plugins/indicator/types';
 import type {Highcharts, HighchartsWidgetData, StringParams} from '../plugins/highcharts/types';
 
-export interface ChartkitWidget {
+export interface ChartKitWidget {
     yagr: {
         data: YagrWidgetData;
         widget: Yagr;