@oliasoft-open-source/charts-library 3.3.8 → 3.4.0-beta-1

package/dist/src/helpers/enums.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @enum {string}
+ */
+export declare const AxisType: Readonly<{
+    X: "x";
+    Y: "y";
+}>;
+/**
+ * @enum {string}
+ */
+export declare const Position: Readonly<{
+    Bottom: "bottom";
+    Top: "top";
+    Left: "left";
+    Right: "right";
+    TopRight: "top-right";
+    TopLeft: "top-left";
+    BottomLeft: "bottom-left";
+    BottomRight: "bottom-right";
+}>;
+/**
+ * @enum {string}
+ */
+export declare const ChartType: Readonly<{
+    Line: "line";
+    Bar: "bar";
+}>;
+/**
+ * @enum {string}
+ */
+export declare const CursorStyle: Readonly<{
+    Pointer: "pointer";
+    Initial: "initial";
+}>;
+/**
+ * @enum {string}
+ */
+export declare const ScaleType: Readonly<{
+    Category: "category";
+    Linear: "linear";
+    Logarithmic: "logarithmic";
+}>;
+/**
+ * @enum {string}
+ */
+export declare const ChartDirection: Readonly<{
+    Vertical: "vertical";
+}>;
+/**
+ * @enum {string}
+ */
+export declare const TooltipLabel: Readonly<{
+    Y: "yLabel";
+    X: "xLabel";
+}>;
+export declare const AlignOptions: Readonly<{
+    End: "end";
+    Start: "start";
+    Center: "center";
+    Right: "right";
+    Left: "left";
+}>;
+export declare const PointType: Readonly<{
+    Casing: "casing";
+}>;
+export declare const AnnotationType: Readonly<{
+    Box: "box";
+    Ellipse: "ellipse";
+    Line: "line";
+    Text: "text";
+}>;
+export declare const PointStyle: Readonly<{
+    Circle: "circle";
+}>;
+export declare const ChartHoverMode: Readonly<{
+    Nearest: "nearest";
+}>;
+export declare const PanZoomMode: Readonly<{
+    X: "x";
+    Y: "y";
+    XY: "xy";
+}>;
+export declare const Key: Readonly<{
+    Shift: "Shift";
+}>;
+export declare const Events: readonly string[];

package/dist/src/helpers/get-chart-annotation.d.ts

@@ -0,0 +1,12 @@
+import { ILineChartOptions } from '../components/line-chart/line-chart.interface';
+import { IInitialState } from './chart-interface';
+/**
+ * @param {import('../components/bar-chart/bar-chart.interface').IBarChartOptions |
+ * import('../components/line-chart/line-chart.interface').ILineChartOptions} options - chart options object
+ * @param {import('./chart-interface').IInitialState} state - chart state object controlled by useReducer or similar
+ * @return {{annotations: []}}
+ */
+declare const getAnnotation: (options: ILineChartOptions, state: IInitialState) => {
+    annotations: {} | null;
+};
+export default getAnnotation;

package/dist/src/helpers/get-draggableData.d.ts

@@ -0,0 +1,18 @@
+import { ILineChartOptions } from '../components/line-chart/line-chart.interface';
+/**
+ * @param {import('./line-chart.interface').ILineChartOptions} options - line chart options object
+ */
+declare const getDraggableData: (options: ILineChartOptions) => {
+    dragData: {
+        dragX: any;
+        dragY: any;
+        round: any;
+        showTooltip: any;
+        onDragStart: any;
+        onDrag: any;
+        onDragEnd: any;
+    };
+} | {
+    dragData?: undefined;
+};
+export default getDraggableData;

package/dist/src/helpers/range/estimate-data-series-have-close-values.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Estimates whether any of the data series has values that are all close together
+ * - checks only the first and last values in each series (i.e. assumes they are ordered)
+ * - uses an equality check with tolerance for decimal precision noise
+ * - this is just an inexpensive "guesstimate" (full min/max detection can be used afterwards)
+ *
+ * @param {Array} generatedDatasets chart dataset series with x, y points
+ * @return {boolean} - at least one series has values that seem close together
+ */
+export declare const estimateDataSeriesHaveCloseValues: (generatedDatasets: Array<any>) => boolean;

package/dist/src/helpers/range/range.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Overrides the default chart.js axis range for some edge-cases:
+ * - when no data -> default range
+ * - when all values are close to zero -> default range
+ * - when all values are close to each other -> custom 5% padding
+ * - when autoAxisPadding is set -> custom 5% padding
+ * - all other cases fall back to chart.js default behaviour
+ *
+ * `autoAxisPadding` feature requirements:
+ * - specified by Truls and ported by Mark+Oleg
+ * - numbers that are equal (within tolerance) shall be presented as a straight line
+ * - all other data series shall use 90% of width of axis (5% padding each side)
+ * - the padding on each side shall be symmetric
+ *
+ * @param {object} args
+ * @param {array<number|null>} args.data
+ * @param {boolean} [args.beginAtZero]
+ * @param {boolean>} [args.autoAxisPadding]
+ * @returns {object} returns {min, max} pair
+ */
+interface IGetuggestedAxisRange {
+    data: any;
+    beginAtZero: boolean;
+    autoAxisPadding: boolean;
+}
+export declare const getSuggestedAxisRange: ({ data, beginAtZero, autoAxisPadding, }: IGetuggestedAxisRange) => {
+    min: number;
+    max: number;
+} | {
+    min: undefined;
+    max: undefined;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oliasoft-open-source/charts-library",
-  "version": "3.3.8",
+  "version": "3.4.0-beta-1",
   "description": "React Chart Library (based on Chart.js and react-chart-js-2)",
   "homepage": "https://gitlab.com/oliasoft-open-source/charts-library",
   "bugs": {
@@ -14,27 +14,27 @@
   "author": "Oliasoft AS and contributors",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "yarn run build:storybook",
     "build:package": "vite build --config vite.config.mjs",
-    "build:storybook": "storybook build --quiet --output-dir ./public",
+    "build": "yarn build:package && storybook build --quiet --output-dir ./public",
     "dev:storybook": "storybook dev -p 6006",
-    "lint:check": "eslint \"**/*.{js,jsx}\"",
-    "lint:fix": "eslint --fix \"**/*.{js,jsx}\"",
+    "lint:check": "eslint \"**/*.{js,jsx,ts,tsx}\"",
+    "lint:fix": "eslint --fix \"**/*.{js,jsx,ts,tsx}\"",
     "prepare": "husky install",
-    "prettier:check": "prettier --check \"**/*.{js,jsx,json,css,less}\"",
-    "prettier:fix": "prettier --write \"**/*.{js,jsx,json,css,less}\"",
+    "prettier:check": "prettier --check \"**/*.{ts,tsx,js,jsx,json,css,less}\"",
+    "prettier:fix": "prettier --write \"**/*.{ts,tsx,js,jsx,json,css,less}\"",
     "preview:storybook": " http-server ./public -o -p 9002 -c-1",
     "test": "yarn run prettier:check && yarn run lint:check && yarn run test:unit",
     "test:unit": "vitest run",
     "test:unit:coverage": "vitest run --coverage"
   },
   "lint-staged": {
-    "*.js": "eslint --cache --fix",
-    "*.{js,jsx,json,css,less}": [
+    "*.{ts,tsx,js,jsx}": "eslint --cache --fix",
+    "*.{ts,tsx,js,jsx,json,css,less}": [
       "prettier --write"
     ]
   },
@@ -57,10 +57,12 @@
     "@oliasoft-open-source/units": "^3.4.2",
     "@storybook/addon-actions": "^7.0.18",
     "@storybook/addon-docs": "^7.0.18",
+    "@storybook/addon-mdx-gfm": "^7.0.23",
     "@storybook/react": "^7.0.18",
     "@storybook/react-vite": "^7.0.18",
     "@storybook/testing-library": "^0.0.14-next.2",
     "@types/react": "^17.0.49",
+    "@typescript-eslint/parser": "^5.60.0",
     "@vitejs/plugin-react-swc": "^3.3.2",
     "ajv": "^8.12.0",
     "ajv-errors": "^3.0.0",
@@ -85,7 +87,6 @@
     "lint-staged": "^13.0.3",
     "lodash": "^4.17.21",
     "prettier": "2.7.1",
-    "prop-types": "^15",
     "react": "^17",
     "react-dom": "^17",
     "rollup-plugin-peer-deps-external": "^2.2.4",
@@ -93,6 +94,8 @@
     "storybook-dark-mode": "^3.0.0",
     "vite": "^4.3.9",
     "vite-plugin-css-injected-by-js": "^3.1.1",
+    "vite-plugin-dts": "2.3.0",
+    "vite-tsconfig-paths": "^4.2.0",
     "vitest": "^0.32.0"
   },
   "peerDependencies": {
@@ -101,7 +104,6 @@
     "classnames": "^2.3.2",
     "immer": "^10.0.2",
     "lodash": "^4.17.21",
-    "prop-types": "^15",
     "react": "^17",
     "react-dom": "^17"
   }