@oliasoft-open-source/charts-library 3.8.0-beta-5 → 3.8.0

package/dist/src/components/line-chart/utils/check-custom-option/check-custom-option.d.ts

@@ -1,15 +1,12 @@
+import { IGeneratedLineChartDataset, TGeneratedLineChartDatasets } from '../../line-chart.interface';
 type TCustomOptionType = {
     [key: string]: string;
 } | string | string[];
-type TDataType = Record<string, unknown> | Array<any>;
+type TDataType = IGeneratedLineChartDataset | Partial<IGeneratedLineChartDataset> | TGeneratedLineChartDatasets | Partial<TGeneratedLineChartDatasets> | any[];
 /**
  * Checks if a single dataset or an array of datasets has a custom option.
  * Iterates through each custom option defined in the customOptions parameter.
  * Returns true if any dataset has any custom option, otherwise returns false.
- *
- * @param {any | any[]} data - The dataset or array of datasets to check.
- * @param {TCustomOptionType} customOptions - The custom options to check for.
- * @returns {boolean} - True if any dataset has any custom option, otherwise false.
  */
 export declare const checkCustomOption: (data: TDataType, customOptions: TCustomOptionType) => boolean;
 export {};

package/dist/src/components/line-chart/utils/datalabels-alignment/datalabels-alignment.interface.d.ts

@@ -0,0 +1,20 @@
+interface IChartArea {
+    left: number | null;
+    right: number | null;
+    bottom: number | null;
+}
+interface IChartMeta {
+    data: Array<{
+        x: number | null;
+        y: number | null;
+    }>;
+}
+export interface IAlignmentContext {
+    chart: {
+        chartArea: IChartArea;
+        getDatasetMeta: (datasetIndex: number) => IChartMeta;
+    };
+    dataIndex: number;
+    datasetIndex: number;
+}
+export {};

package/dist/src/components/line-chart/utils/datalabels-alignment/get-alignment-condition.d.ts

@@ -1,8 +1,7 @@
-/** returning boolean condition depends on label position and chart area
- *
- * @return {object} - returning object with boolean props
+/**
+ * Returning boolean condition depends on label position and chart area
  */
-export declare const getCondition: (x: number, y: number, left: number, right: number, bottom: number) => {
+export declare const getCondition: (x: number | null, y: number | null, left: number | null, right: number | null, bottom: number | null) => {
     overLeftSide: boolean;
     overRightSide: boolean;
     overBottomSide: boolean;

package/dist/src/components/line-chart/utils/datalabels-alignment/get-alignment-data.d.ts

@@ -1,11 +1,11 @@
-/** returning destructured data from context
- *
- * @return {object}
+import { IAlignmentContext } from './datalabels-alignment.interface';
+/**
+ * Returning destructured data from context
  */
-export declare const getAlignmentData: (context: any) => {
-    x: any;
-    y: any;
-    left: any;
-    right: any;
-    bottom: any;
+export declare const getAlignmentData: (context: IAlignmentContext) => {
+    x: number | null;
+    y: number | null;
+    left: number | null;
+    right: number | null;
+    bottom: number | null;
 };

package/dist/src/components/line-chart/utils/datalabels-alignment/get-datalabels-position.d.ts

@@ -1,6 +1,6 @@
 import { AlignOptions } from '../../../common/helpers/enums';
-/** returning position depends on condition
- *
- * @return {string} - position
+import { IAlignmentContext } from './datalabels-alignment.interface.ts';
+/**
+ * Returning position depends on condition
  */
-export declare const getPosition: () => (context: any) => AlignOptions.End | AlignOptions.Start | AlignOptions.Right | AlignOptions.Left;
+export declare const getPosition: () => (context: IAlignmentContext) => AlignOptions.End | AlignOptions.Start | AlignOptions.Right | AlignOptions.Left;

package/dist/src/components/line-chart/utils/generate-line-chart-datasets.d.ts

@@ -1,12 +1,8 @@
 import { IState } from '../state/state.interfaces';
-import { ILineChartOptions } from '../line-chart.interface';
+import { ILineChartOptions, TGeneratedLineChartDatasets } from '../line-chart.interface';
 /**
  * Generates line chart datasets based on the provided datasets, state, and options.
- *
- * @param {Array} datasets - The initial datasets for the line chart.
- * @param {Object} state - The state object containing chart settings (e.g., lineEnabled, pointsEnabled, axes).
- * @param {Object} options - The options object containing additional settings (e.g., annotations, graph).
- * @param {Object} translations - The getTranslations object with the label property
- * @returns {Array} - The generated line chart datasets with applied settings and configurations.
  */
-export declare const generateLineChartDatasets: (datasets: Array<any>, state: IState, options: ILineChartOptions, { label }: any) => any[];
+export declare const generateLineChartDatasets: (datasets: Array<any>, state: IState, options: ILineChartOptions, { label }: {
+    label: string;
+}) => TGeneratedLineChartDatasets;

package/dist/src/components/line-chart/utils/get-axes-ranges-from-chart.d.ts

@@ -1,13 +1,9 @@
 import { Chart } from 'chart.js';
 import { RefObject } from 'react';
-import { IInitAxisRange } from '../state/state.interfaces';
-interface IAxes {
-    [key: string]: IInitAxisRange[];
-}
-export declare const getAxesRangesFromChart: (chartRef: RefObject<Chart>, axes: IAxes) => {
-    unit?: string | undefined;
-    id: any;
-    min: any;
-    max: any;
+import { ILineChartAxes } from '../line-chart.interface';
+export declare const getAxesRangesFromChart: (chartRef: RefObject<Chart>, axes: ILineChartAxes) => {
+    unit?: import("../line-chart.interface").IUnitOptions | undefined;
+    id: string;
+    min: number;
+    max: number;
 }[];
-export {};

package/dist/src/components/line-chart/utils/get-generated-labels.d.ts

@@ -1 +1,2 @@
-export declare const getGeneratedLabels: (chart: any) => any;
+import { Chart, LegendItem } from 'chart.js';
+export declare const getGeneratedLabels: (chart: Chart) => LegendItem[];

package/dist/src/components/line-chart/utils/get-line-chart-data-labels.d.ts

@@ -1,5 +1,6 @@
 import { TooltipItem } from 'chart.js';
 import { ILineChartOptions } from '../line-chart.interface';
+import { UnusedParameter } from '../../common/common.interface';
 /**
  * adjusts the position of the label depends on chart area
  *
@@ -8,8 +9,8 @@ import { ILineChartOptions } from '../line-chart.interface';
  */
 declare const getLineChartDataLabels: (options: ILineChartOptions) => {
     display: string;
-    align: (context: any) => import("../../common/helpers/enums").AlignOptions.End | import("../../common/helpers/enums").AlignOptions.Start | import("../../common/helpers/enums").AlignOptions.Right | import("../../common/helpers/enums").AlignOptions.Left;
-    formatter: (_value: any, context: TooltipItem<any>) => any;
+    align: (context: import("./datalabels-alignment/datalabels-alignment.interface").IAlignmentContext) => import("../../common/helpers/enums").AlignOptions.End | import("../../common/helpers/enums").AlignOptions.Start | import("../../common/helpers/enums").AlignOptions.Right | import("../../common/helpers/enums").AlignOptions.Left;
+    formatter: (_: UnusedParameter, context: TooltipItem<any>) => any;
 } | {
     display: boolean;
     align?: undefined;

package/dist/src/components/line-chart/utils/get-line-chart-scales.d.ts

@@ -1,9 +1,4 @@
 import { IState } from '../state/state.interfaces';
 import { ILineChartOptions } from '../line-chart.interface';
-/**
- *
- * @param {ILineChartOptions} options - line chart options object
- * @param {IState} state - chart state object controlled by useReducer or similar
- */
-declare const getLineChartScales: (options: ILineChartOptions, state: IState) => any;
+declare const getLineChartScales: (options: ILineChartOptions, state: IState) => {};
 export default getLineChartScales;

package/dist/src/components/line-chart/utils/get-line-chart-tooltips.d.ts

@@ -1,9 +1,7 @@
+import { TooltipItem } from 'chart.js';
 import { ChartHoverMode } from '../../common/helpers/enums';
 import { ILineChartOptions } from '../line-chart.interface';
 export declare const getUnitsFromLabel: (label: string) => string;
-/**
- * @param {import('../line-chart.interface').ILineChartOptions} options - line chart options object
- */
 declare const getLineChartToolTips: (options: ILineChartOptions) => {
     enabled: boolean;
     mode: ChartHoverMode;
@@ -14,8 +12,8 @@ declare const getLineChartToolTips: (options: ILineChartOptions) => {
     boxHeight: number;
     boxPadding: number;
     callbacks: {
-        title: (tooltipItem: any, _data: any) => string;
-        label: (tooltipItem: any) => string;
+        title: (tooltipItem: TooltipItem<any>[]) => string;
+        label: (tooltipItem: TooltipItem<any>) => string;
         afterLabel: (tooltipItem: Record<string, any>) => string;
     };
 };

package/dist/src/components/line-chart/utils/line-chart-utils.d.ts

@@ -1,4 +1,5 @@
 import { ILineRange } from '../line-chart.interface';
+import { TPrimitive } from '../../common/common.interface';
 export declare const toNum: (value: string | number) => any;
 export declare const isLessThanMax: (value: string | number, max: string | number) => boolean;
 export declare const isGreaterThanMin: (value: string | number, min: string | number) => boolean;
@@ -19,21 +20,13 @@ export declare const getAxisTypeFromKey: (string: string) => string;
 /**
  * Generates a key based on an array of values. The key changes
  * if any of the values in the array change.
- *
- * @param {Array} values - The array of values to base the key on.
- * @returns {String} The key.
  */
 export declare const generateKey: (values: Array<any>) => string;
 /**
  * Checks if a value is a primitive value (which includes strings, numbers, booleans, and null).
- * @param {*} value - The value to check.
- * @returns {boolean} - Returns true if the value is a primitive value, otherwise false.
  */
-export declare const isPrimitiveValue: (value: any) => boolean;
+export declare const isPrimitiveValue: (value: TPrimitive) => boolean;
 /**
  * Validates a range object to ensure none of its properties are null, undefined, or empty strings.
- *
- * @param {Object} r - The range object to validate.
- * @returns {boolean} True if all properties of the range are valid, otherwise false.
  */
 export declare const isRangeValid: (r?: ILineRange) => boolean;

package/dist/src/components/pie-chart/pie-chart-defalut-props.interface.d.ts

@@ -0,0 +1,53 @@
+import { ChartEvent } from 'chart.js';
+import { IPieChartDataset, IPieOptions } from './pie-chart.interface';
+import { AlignOptions, Position } from '../common/helpers/enums';
+interface IDefaultChartStyling {
+    width?: number | string;
+    height?: number | string;
+    maintainAspectRatio: boolean;
+    staticChartHeight: boolean;
+    performanceMode: boolean;
+}
+interface IDefaultTooltip {
+    tooltips: boolean;
+    showLabelsInTooltips: boolean;
+}
+interface IDefaultPieGraph {
+    showDataLabels: boolean;
+    stacked: boolean;
+    cutout: number | string;
+}
+interface IDefaultPieLegend {
+    display: boolean;
+    useDataset: boolean;
+    position: Position;
+    align: AlignOptions;
+}
+interface IDefaultChartOptions {
+    enableZoom: boolean;
+    enablePan: boolean;
+}
+interface IDefaultInteractions {
+    onLegendClick?: (text: string, hidden: boolean) => void;
+    onHover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: IPieChartDataset[]) => void;
+    onUnhover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: any[]) => void;
+}
+interface IDefaultChartData {
+    labels: string[];
+    datasets: IPieChartDataset[];
+}
+interface IDefaultPieOptions extends IPieOptions {
+    title: string | string[];
+    chartStyling: IDefaultChartStyling;
+    tooltip: IDefaultTooltip;
+    graph: IDefaultPieGraph;
+    legend: IDefaultPieLegend;
+    chartOptions: IDefaultChartOptions;
+    interactions: IDefaultInteractions;
+}
+export interface IPieChartDefaultProps {
+    testId: string | null;
+    data: IDefaultChartData;
+    options: IDefaultPieOptions;
+}
+export {};

package/dist/src/components/pie-chart/pie-chart-get-default-props.d.ts

@@ -1,43 +1,3 @@
 import { IPieChartProps } from './pie-chart.interface';
-import { AlignOptions, Position } from '../common/helpers/enums';
-export declare const getDefaultProps: (props: IPieChartProps) => {
-    testId: string | null;
-    data: {
-        labels: string[];
-        datasets: import("./pie-chart.interface").IPieChartDataset[];
-    };
-    options: {
-        title: string | string[];
-        chartStyling: {
-            width: string | number | undefined;
-            height: string | number | undefined;
-            maintainAspectRatio: boolean;
-            staticChartHeight: boolean;
-            performanceMode: boolean;
-        };
-        tooltip: {
-            tooltips: boolean;
-            showLabelsInTooltips: boolean;
-        };
-        graph: {
-            showDataLabels: boolean;
-            stacked: boolean;
-            cutout: string | number;
-        };
-        legend: {
-            display: boolean;
-            useDataset: boolean;
-            position: Position;
-            align: AlignOptions;
-        };
-        chartOptions: {
-            enableZoom: boolean;
-            enablePan: boolean;
-        };
-        interactions: {
-            onLegendClick: ((text: string, hidden: boolean) => void) | undefined;
-            onHover: ((event?: import("chart.js").ChartEvent | undefined, datasetIndex?: number | undefined, index?: number | undefined, generatedDataset?: any[] | undefined) => void) | undefined;
-            onUnhover: ((event?: import("chart.js").ChartEvent | undefined, datasetIndex?: number | undefined, index?: number | undefined, generatedDataset?: any[] | undefined) => void) | undefined;
-        };
-    };
-};
+import { IPieChartDefaultProps } from './pie-chart-defalut-props.interface';
+export declare const getDefaultProps: (props: IPieChartProps) => IPieChartDefaultProps;

package/dist/src/components/pie-chart/pie-chart.interface.d.ts

@@ -16,7 +16,7 @@ export interface IPieDataValue extends ICommonDataValue {
     borderWidth: string | number;
     value: number;
     backgroundColor?: string | string[];
-    borderColor?: string;
+    borderColor?: string | string[];
     labels: string[];
 }
 export interface IPieChartDataset extends ICommonDataset {
@@ -30,11 +30,12 @@ export interface IPieData {
     yUnit?: string;
 }
 export interface IPieChartData extends ICommonData {
-    data?: IPieData;
+    data: IPieData;
     options: IPieOptions;
 }
 export interface IPieChartProps {
     chart: IPieChartData;
+    testId?: string | null;
 }
 export interface IPieGeneratedLabel {
     text: string;
@@ -53,3 +54,10 @@ export interface IPiesDataLabelsOptions {
     anchor?: 'center';
     formatter?: (_value: any, context: any) => any;
 }
+export interface IGeneratedPieChartDataset {
+    label: string;
+    backgroundColor: string[];
+    borderColor: string[];
+    borderWidth: number;
+    data: IPieDataValue[];
+}

package/dist/src/components/pie-chart/use-pie-chart-config.d.ts

@@ -0,0 +1,41 @@
+import { ActiveElement, Chart, Chart as ChartJS, ChartEvent, LegendItem, Plugin, TooltipItem } from 'chart.js';
+import { IGeneratedPieChartDataset, IPieDataValue, IPiesDataLabelsOptions } from './pie-chart.interface';
+import { IPieChartDefaultProps } from './pie-chart-defalut-props.interface';
+import { UnusedParameter } from '../common/common.interface';
+interface ILegendPlugin extends Plugin {
+    chart?: Chart;
+}
+export declare const usePieChartConfig: (chart: IPieChartDefaultProps) => {
+    generatedDatasets: IGeneratedPieChartDataset[] | {
+        borderWidth: number;
+        borderColor: string | string[];
+        backgroundColor: string | string[];
+        data: IPieDataValue[];
+        hideLegend?: boolean | undefined;
+        label?: string | undefined;
+    }[];
+    getTitle: () => {
+        display: boolean;
+        text: string | string[];
+    } | {
+        display?: undefined;
+        text?: undefined;
+    };
+    legendClick: (_: UnusedParameter, legendItem?: LegendItem, legend?: ILegendPlugin) => void;
+    onClick: (_evt: ChartEvent, _elements: ActiveElement[], chartInstance: ChartJS) => void;
+    onHover: (evt: ChartEvent, hoveredItems: ActiveElement[]) => void;
+    getDatalabels: () => IPiesDataLabelsOptions;
+    getLegend: () => object;
+    getToolTips: () => {
+        callbacks: {
+            title: (tooltipItem: TooltipItem<any>[]) => string;
+            label: (tooltipItem: TooltipItem<any>) => string;
+        };
+        padding: number;
+        boxWidth: number;
+        boxHeight: number;
+        boxPadding: number;
+        usePointStyle: boolean;
+    };
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oliasoft-open-source/charts-library",
-  "version": "3.8.0-beta-5",
+  "version": "3.8.0",
   "description": "React Chart Library (based on Chart.js and react-chart-js-2)",
   "homepage": "https://gitlab.com/oliasoft-open-source/charts-library",
   "resolutions": {
@@ -42,7 +42,6 @@
     ]
   },
   "dependencies": {
-    "@fontsource/noto-sans": "^5.0.18",
     "chart.js": "^4.2.1",
     "chartjs-plugin-annotation": "^3.0.1",
     "chartjs-plugin-datalabels": "^2.1.0",
@@ -58,7 +57,7 @@
     "react-use": "^17.4.0"
   },
   "devDependencies": {
-    "@oliasoft-open-source/react-ui-library": "4.0.0-beta-75",
+    "@oliasoft-open-source/react-ui-library": "^3.15.1",
     "@oliasoft-open-source/units": "^3.4.2",
     "@storybook/addon-actions": "^7.0.18",
     "@storybook/addon-docs": "^7.0.18",

package/dist/src/components/bar-chart/get-bar-chart-scales.d.ts

@@ -1,5 +0,0 @@
-/**
- * @param {IBarChartData} chart - chart data
- */
-declare const getBarChartScales: (chart: any) => any;
-export default getBarChartScales;

package/dist/src/components/line-chart/controls/legend-options.d.ts

@@ -1 +0,0 @@
-export declare const LegendOptions: ({ legendEnabled, onToggleLegend, translations: { hideLegend, showLegend }, }: any) => import("react/jsx-runtime").JSX.Element;