@gravity-ui/chartkit 0.10.1 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.11.0](https://github.com/gravity-ui/chartkit/compare/v0.10.1...v0.11.0) (2022-11-18)
+
+
+### Features
+
+* types improvements ([#67](https://github.com/gravity-ui/chartkit/issues/67)) ([33b4f07](https://github.com/gravity-ui/chartkit/commit/33b4f07a24abdfde52005ddbbf17fb7a25817beb))
+
 ## [0.10.1](https://github.com/gravity-ui/chartkit/compare/v0.10.0...v0.10.1) (2022-11-18)
 
 

package/build/components/ChartKit.d.ts

@@ -1,19 +1,19 @@
 import React from 'react';
-import type { ChartkitType, ChartKitRef, ChartKitProps } from '../types';
+import type { ChartKitType, ChartKitRef, ChartKitProps } from '../types';
 import '@gravity-ui/uikit/styles/styles.css';
 import './ChartKit.css';
-declare type ChartKitComponentProps<T extends ChartkitType> = Omit<ChartKitProps<T>, 'onError'> & {
+declare type ChartKitComponentProps<T extends ChartKitType> = Omit<ChartKitProps<T>, 'onError'> & {
     instanceRef?: React.ForwardedRef<ChartKitRef | undefined>;
 };
-declare const ChartKitComponent: <T extends keyof import("../types").ChartkitWidget>(props: ChartKitComponentProps<T>) => JSX.Element;
-export declare const ChartKit: <T extends keyof import("../types").ChartkitWidget>(props: {
+declare const ChartKitComponent: <T extends keyof import("../types").ChartKitWidget>(props: ChartKitComponentProps<T>) => JSX.Element;
+export declare const ChartKit: <T extends keyof import("../types").ChartKitWidget>(props: {
     type: T;
-    data: import("../types").ChartkitWidget[T]["data"];
+    data: import("../types").ChartKitWidget[T]["data"];
     id?: string | undefined;
     isMobile?: boolean | undefined;
     onLoad?: ((data?: import("../types").ChartKitOnLoadData<T> | undefined) => void) | undefined;
     onError?: import("../types").ChartKitOnError | undefined;
-} & { [key in keyof Omit<import("../types").ChartkitWidget[T], "widget" | "data">]: import("../types").ChartkitWidget[T][key]; } & {
+} & { [key in keyof Omit<import("../types").ChartKitWidget[T], "widget" | "data">]: import("../types").ChartKitWidget[T][key]; } & {
     ref?: React.ForwardedRef<ChartKitRef | undefined> | undefined;
 }) => ReturnType<typeof ChartKitComponent>;
 export {};

package/build/index.d.ts

@@ -1,5 +1,5 @@
 import { ChartKit } from './components/ChartKit';
 import { settings } from './libs';
-export type { ChartKitLang, ChartKitOnLoadData, ChartKitOnError, ChartKitPlugin, ChartKitProps, ChartKitRef, ChartKitWidgetRef, ChartkitType, ChartkitWidget, } from './types';
+export type { ChartKitLang, ChartKitOnLoadData, ChartKitOnError, ChartKitPlugin, ChartKitProps, ChartKitRef, ChartKitWidgetRef, ChartKitType, ChartKitWidget, } from './types';
 export { settings };
 export default ChartKit;

package/build/plugins/highcharts/renderer/components/HighchartsComponent.d.ts

@@ -550,8 +550,8 @@ export declare class HighchartsComponent extends React.PureComponent<Props, Stat
                 text: any;
             };
             series: any;
-            _externalComments: import("../../types").ChartKitComment[];
-            _internalComments: import("../../types").ChartKitComment[];
+            _externalComments: import("../../types").HighchartsComment[];
+            _internalComments: import("../../types").HighchartsComment[];
         };
         callback: (chart: import("../../types").ExtendedHChart) => void;
         isError: boolean;

package/build/plugins/highcharts/renderer/helpers/graph.d.ts

@@ -1,11 +1,11 @@
 import type { ChartKitHolidays } from '../../../../types';
-import type { HighchartsWidgetData, ChartKitComment, ExtendedHChart } from '../../types';
+import type { HighchartsWidgetData, HighchartsComment, ExtendedHChart } from '../../types';
 import type { ConfigOptions } from './types';
 import './graph.css';
 declare type GetGraphArgs = {
     options: ConfigOptions;
     data: HighchartsWidgetData['data'];
-    comments?: ChartKitComment[];
+    comments?: HighchartsComment[];
     holidays?: ChartKitHolidays;
     isMobile?: boolean;
 };
@@ -544,8 +544,8 @@ declare function getGraph({ options, data, comments, isMobile, holidays }: GetGr
             text: any;
         };
         series: any;
-        _externalComments: ChartKitComment[];
-        _internalComments: ChartKitComment[];
+        _externalComments: HighchartsComment[];
+        _internalComments: HighchartsComment[];
     };
     callback: (chart: ExtendedHChart) => void;
 };

package/build/plugins/highcharts/types/comments.d.ts

@@ -47,5 +47,5 @@ interface CommentFlagX extends CommentBase {
         shape: string;
     };
 }
-export declare type ChartKitComment = CommentDotXY | CommentBandX | CommentLineX | CommentFlagX;
+export declare type HighchartsComment = CommentDotXY | CommentBandX | CommentLineX | CommentFlagX;
 export {};

package/build/plugins/highcharts/types/index.d.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';

package/build/plugins/highcharts/types/misc.d.ts

@@ -1,4 +1,4 @@
-import type { ChartKitComment } from './comments';
+import type { HighchartsComment } from './comments';
 export declare type StringParams = Record<string, string | string[]>;
 export declare type DrillDownConfig = {
     breadcrumbs: string[];
@@ -10,9 +10,9 @@ export declare type XAxisItem = Highcharts.Axis & {
 };
 export declare 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'];

package/build/plugins/highcharts/types/widget.d.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';
 declare type GraphWidgetSeriesOptions = Highcharts.SeriesOptionsType & {
     title?: string;
@@ -16,7 +16,7 @@ export declare type HighchartsWidgetData = {
     } | {
         graphs: GraphWidgetSeriesOptions[];
     }) & {
-        comments?: ChartKitComment[];
+        comments?: HighchartsComment[];
     };
     config: {
         hideComments?: boolean;
@@ -41,7 +41,7 @@ export declare type HighchartsWidgetData = {
     };
     libraryConfig: Highcharts.Options;
     params?: StringParams;
-    comments?: ChartKitComment[];
+    comments?: HighchartsComment[];
     sideMarkdown?: string;
 };
 export {};

package/build/plugins/index.d.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';

package/build/types/index.d.ts

@@ -1,33 +1,33 @@
 /// <reference types="react" />
-import type { ChartkitWidget } from './widget';
+import type { ChartKitWidget } from './widget';
 export type { ChartKitHolidays } from './misc';
 export declare type ChartKitLang = 'ru' | 'en';
-export declare type ChartkitType = keyof ChartkitWidget;
+export declare type ChartKitType = keyof ChartKitWidget;
 export declare type ChartKitRef = {
     reflow: (details?: unknown) => void;
 };
 export declare type ChartKitWidgetRef = {
     reflow?: ChartKitRef['reflow'];
 };
-export declare type ChartKitOnLoadData<T extends ChartkitType> = {
-    widget?: ChartkitWidget[T]['widget'];
+export declare type ChartKitOnLoadData<T extends ChartKitType> = {
+    widget?: ChartKitWidget[T]['widget'];
     widgetRendering?: number;
 };
 export declare type ChartKitOnError = (data: {
     error: any;
 }) => void;
-export declare type ChartKitProps<T extends ChartkitType> = {
+export declare 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 declare type ChartKitPlugin = {
-    type: ChartkitType;
+    type: ChartKitType;
     renderer: React.LazyExoticComponent<any>;
 };
-export type { ChartkitWidget };
+export type { ChartKitWidget };

package/build/types/widget.d.ts

@@ -2,7 +2,7 @@ import type Yagr from 'yagr';
 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/chartkit",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "React component used to render charts based on any sources you need",
   "license": "MIT",
   "repository": "git@github.com:gravity-ui/ChartKit.git",