@oliasoft-open-source/charts-library 2.17.0-beta-2 → 2.17.0-beta-3

package/index.js

@@ -5,8 +5,7 @@
 import ScatterChart from './src/components/scatter-chart/scatter-chart';
 
 export { LineChart } from './src/components/line-chart/line-chart';
-export { initializeLineChart } from './src/components/line-chart/utils/initialize/initialize-line-chart';
-export { updateTranslations } from './src/components/line-chart/utils/translations/translations';
+export { initializeLineChart } from './src/components/line-chart/initialize/initialize-line-chart';
 
 export { PieChart } from './src/components/pie-chart/pie-chart';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oliasoft-open-source/charts-library",
-  "version": "2.17.0-beta-2",
+  "version": "2.17.0-beta-3",
   "description": "React Chart Library (based on Chart.js and react-chart-js-2)",
   "homepage": "https://gitlab.com/oliasoft-open-source/charts-library",
   "bugs": {

package/release-notes.md

@@ -1,7 +1,7 @@
 # Charts Library Release Notes
 
 ## 2.17.0
-- Added initialize logic, for improve translations
+- Added initialize logic, for improve getTranslations
 
 ## 2.15.0
 - Added translation, by provider handled([OW-11237](https://oliasoft.atlassian.net/browse/OW-11237))

package/src/components/line-chart/constants/line-chart-consts.js

@@ -8,4 +8,5 @@ export const ZOOM_BOX_BACKGROUND_COLOR = 'rgba(0, 0, 0, 0.1)';
 export const DOUBLE_CLICK = 'dblclick';
 export const INIT_KEYS = {
   TRANSLATIONS: 'translations',
+  LANGUAGE_KEY: 'languageKey',
 };

package/src/components/line-chart/{utils/initialize → initialize}/config.js

@@ -1,16 +1,17 @@
-import { INIT_KEYS } from '../../constants/line-chart-consts';
-import { defaultTranslations } from '../../constants/default-translations';
+import { INIT_KEYS } from '../constants/line-chart-consts';
+import { getTranslations } from '../utils/translations/get-translations';
 
 const config = {
-  [INIT_KEYS.TRANSLATIONS]: defaultTranslations,
+  [INIT_KEYS.TRANSLATIONS]: getTranslations(),
+  [INIT_KEYS.LANGUAGE_KEY]: 'en',
 };
 
 /**
  * Retrieve the value for the given key from the config object.
  * @param {string} key - The key to access the corresponding value in the config object.
- * @returns {*} - The value associated with the given key in the config object.
+ * @returns {*} - The value associated with the given key in the config object or config.
  */
-export const getConfig = (key) => config[key];
+export const getConfig = (key) => (key ? config[key] : config);
 
 /**
  * Set a new value for the given key in the config object.

package/src/components/line-chart/initialize/initialize-line-chart.js

@@ -0,0 +1,25 @@
+import { INIT_KEYS } from '../constants/line-chart-consts';
+import { setConfig } from './config';
+import { isPrimitiveValue } from '../utils/line-chart-utils';
+import { getTranslations } from '../utils/translations/get-translations';
+
+/**
+ * Initialize the charts library with the provided configurations.
+ * This function will store the configuration options in a config object.
+ * @param {object} options - An object containing the configuration options for the library.
+ * @param {object} options.getTranslations - The getTranslations to be used in the library.
+ * @param {string} options.languageKey - The language key to be stored in the config object, used for getTranslations.
+ * @param {...object} options - Any additional options to be stored in the config object.
+ */
+export const initializeLineChart = ({ languageKey = 'en', ...options }) => {
+  setConfig(INIT_KEYS.LANGUAGE_KEY, languageKey);
+
+  Object.entries(options).forEach(([key, value]) => {
+    if (key === INIT_KEYS.TRANSLATIONS) {
+      setConfig(key, getTranslations(value));
+    } else {
+      const newValue = isPrimitiveValue(value) ? value : { ...value };
+      setConfig(key, newValue);
+    }
+  });
+};

package/src/components/line-chart/line-chart.jsx

@@ -29,8 +29,7 @@ import { useChartOptions } from './hooks/use-chart-options';
 import { useChartPlugins } from './hooks/use-chart-plugins';
 import { generateKey } from './utils/line-chart-utils';
 import { useChartState } from './state/use-chart-state';
-import { INIT_KEYS } from './constants/line-chart-consts';
-import { getConfig } from './utils/initialize/config';
+import { getConfig } from './initialize/config';
 
 ChartJS.register(
   LinearScale,
@@ -56,7 +55,8 @@ const LineChart = (props) => {
   setDefaultTheme();
   const chartRef = useRef(null);
   const { table } = props;
-  const translations = getConfig(INIT_KEYS.TRANSLATIONS);
+  const { translations, languageKey } = getConfig();
+
   const chart = getDefaultProps(props);
   const {
     data: { datasets },
@@ -116,6 +116,7 @@ const LineChart = (props) => {
         state.enableDragPoints,
         state.zoomEnabled,
         state.panEnabled,
+        languageKey,
       ])}
       className={getClassName(chartStyling, styles)}
       style={{

package/src/components/line-chart/utils/generate-line-chart-datasets.js

@@ -15,7 +15,7 @@ import { generateRandomColor } from '../../../helpers/chart-utils';
  * @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 translations object with the label property
+ * @param {Object} translations - The getTranslations object with the label property
  * @returns {Array} - The generated line chart datasets with applied settings and configurations.
  */
 export const generateLineChartDatasets = (

package/src/components/line-chart/utils/line-chart-utils.js

@@ -68,3 +68,14 @@ export const generateKey = (values) => {
   const key = values.join('');
   return key;
 };
+
+/**
+ * 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 const isPrimitiveValue = (value) =>
+  typeof value === 'string' ||
+  typeof value === 'number' ||
+  typeof value === 'boolean' ||
+  value === null;

package/src/components/line-chart/utils/translations/get-translations.js

@@ -0,0 +1,17 @@
+import { defaultTranslations } from '../../constants/default-translations';
+
+/**
+ * Merges custom getTranslations with the default getTranslations.
+ * If a custom translation is provided for a key, it will override the default one.
+ * @param {object} translations - Custom getTranslations.
+ * @returns {object} - The resulting getTranslations object, containing both default and custom getTranslations.
+ */
+export const getTranslations = (translations = {}) => {
+  return Object.keys(defaultTranslations).reduce(
+    (acc, key) => ({
+      ...acc,
+      [key]: translations[key] || defaultTranslations[key],
+    }),
+    {},
+  );
+};

package/src/components/line-chart/utils/initialize/initialize-line-chart.js

@@ -1,18 +0,0 @@
-import { translations } from '../translations/translations';
-import { INIT_KEYS } from '../../constants/line-chart-consts';
-import { setConfig } from './config';
-
-/**
- * Initialize the charts library with the provided configurations.
- * This function will store the configuration options in a config object.
- * @param {object} options - An object containing the configuration options for the library.
- */
-export const initializeLineChart = (options = {}) => {
-  Object.entries(options).forEach(([key, value]) => {
-    if (key === INIT_KEYS.TRANSLATIONS) {
-      setConfig(INIT_KEYS.TRANSLATIONS, translations(value));
-    } else {
-      setConfig(INIT_KEYS.TRANSLATIONS, { ...value });
-    }
-  });
-};

package/src/components/line-chart/utils/translations/translations.js

@@ -1,30 +0,0 @@
-import { defaultTranslations } from '../../constants/default-translations';
-import { INIT_KEYS } from '../../constants/line-chart-consts';
-import { setConfig } from '../initialize/config';
-
-/**
- * Merges custom translations with the default translations.
- * If a custom translation is provided for a key, it will override the default one.
- * @param {object} translations - Custom translations.
- * @returns {object} - The resulting translations object, containing both default and custom translations.
- */
-export const translations = (translations = {}) => {
-  return Object.keys(defaultTranslations).reduce(
-    (acc, key) => ({
-      ...acc,
-      [key]: translations[key] || defaultTranslations[key],
-    }),
-    {},
-  );
-};
-
-/**
- * Updates the translations configuration with new translations.
- *
- * @param {object} newTranslations - The new translations to be added.
- * @returns {void}
- */
-export function updateTranslations(newTranslations) {
-  const updatedTranslations = translations(newTranslations);
-  setConfig(INIT_KEYS.TRANSLATIONS, updatedTranslations);
-}