@hortiview/shared-components 0.0.11747 → 0.0.11881

package/README.md

@@ -64,6 +64,10 @@ Additionally the library provides form components using [react-hook-form](https:
 1. [trimLeadingAndTrailingSpaces](#trimleadingandtrailingspaces)
 1. [getNumberAsLocaleString](#getnumberaslocalestring)
 
+## Available constants
+
+1. [Languages and countries](#languages-and-countries)
+
 ## Available Components:
 
 ### AlertBanner
@@ -1027,3 +1031,27 @@ const overlineTitle = `${getNumberAsLocaleString(userLocale, totalArea, 5)} ${t(
   'squaremeter-unit'
 )}`;
 ```
+
+## Available constants
+
+### Languages and countries
+
+The file contains different languages and country constants as well as language ids, which represents the available languages and countries of the hortiview platform.
+
+The supported languages are:
+
+- English (en)
+- Spanish (es)
+- Turkish (tr)
+
+The supported countries are:
+
+- Spain (esp)
+- Mexico (mex)
+- Turkey (tur)
+
+```typescript
+const languageCode = 'en' as AVAILABLE_LANGUAGE_CODES;
+const languageCountryCode = LANGUAGE_CODES_MAPPER[languageCode];
+console.log(languageCountryCode); // 'en-US'
+```

package/dist/components/FormComponents/FormNumber/FormNumber.test.js

@@ -44,7 +44,7 @@ e.mock("react-hook-form", () => ({
 }));
 m("FormNumber Test", () => {
   f("render FormNumber with correct properties", () => {
-    a(/* @__PURE__ */ o(s, { languageCode: "de-DE", propertyName: "de-DE" }));
+    a(/* @__PURE__ */ o(s, { languageCode: "es-MX", propertyName: "es-MX" }));
     const t = n.getByRole("textbox");
     r(t).toBeInTheDocument(), r(t).toHaveAttribute("type", "text"), r(t).toHaveAttribute("inputmode", "decimal");
   });

package/dist/components/HealthCheckFailed/HealthCheckFailed.d.ts

@@ -1,4 +1,4 @@
-type HealthCheckFailedProps = {
+export type HealthCheckFailedProps = {
     /**
      * Please check the shared components README for the correct title for each type.
      * Font size: 16px, font weight: 700
@@ -19,4 +19,3 @@ type HealthCheckFailedProps = {
     isOutlined?: boolean;
 };
 export declare const HealthCheckFailed: ({ title, subtitle, type, isOutlined, }: HealthCheckFailedProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/LoadingSpinner/Default/LoadingSpinner.d.ts

@@ -1,4 +1,4 @@
-type LoadingSpinnerProps = {
+export type LoadingSpinnerProps = {
     /**
      * center the spinner in the middle of the container
      */
@@ -49,4 +49,3 @@ type LoadingSpinnerProps = {
  * @returns a loading spinner component
  */
 export declare const LoadingSpinner: ({ size, center, text, textPosition, color, spinnerOnly, impatienceMessage, impatienceTimeout, }: LoadingSpinnerProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/main.d.ts

@@ -40,10 +40,12 @@ export { capitalizeFirstLetters, getNumberAsLocaleString, trimLeadingAndTrailing
 export type { ActionProps } from './components/ContextMenu/ContextMenu';
 export type { FormSelectOption } from './components/FormComponents/FormSelect/FormSelect';
 export type { FormTextProps } from './components/FormComponents/FormText/FormText';
+export type { HealthCheckFailedProps } from './components/HealthCheckFailed/HealthCheckFailed';
 export type { FieldItem } from './components/InfoGroup/InfoGroup';
+export type { LoadingSpinnerProps } from './components/LoadingSpinner/Default/LoadingSpinner';
 export type { FilterData, FilterOption, FilterSelection } from './types/Filter';
 export type { CellTemplate, CellTemplateProps, TableLayoutProps } from './types/GenericTable';
 export type { HashTab } from './types/HashTab';
 export type { BaseListElement, ListElement } from './types/ListElement';
-export { LANGUAGE_CODES_MAPPER } from './types/Languages';
-export type { LANGUAGE_CODES, LANGUAGE_COUNTRY_CODES } from './types/Languages';
+export { AVAILABLE_COUNTRY_KEYS, AVAILABLE_LOCALES, ENGLISH_LANGUAGE_ID, GERMAN_LANGUAGE_ID, LANGUAGE_CODES_MAPPER, LANGUAGE_ID_MAPPER, SPANISH_LANGUAGE_ID, TURKISH_LANGUAGE_ID, } from './types/Languages';
+export type { AVAILABLE_LANGUAGE_CODES, LANGUAGE_COUNTRY_CODES } from './types/Languages';

package/dist/main.js

@@ -3,25 +3,25 @@ import { AlertBanner as t } from "./components/AlertBanner/AlertBanner.js";
 import { BaseView as p } from "./components/BaseView/BaseView.js";
 import { BasicHeading as x } from "./components/BasicHeading/BasicHeading.js";
 import { BlockView as a } from "./components/BlockView/BlockView.js";
-import { ChipCard as c } from "./components/ChipCard/ChipCard.js";
-import { ContextMenu as d } from "./components/ContextMenu/ContextMenu.js";
-import { DeleteModal as F } from "./components/DeleteModal/DeleteModal.js";
-import { Disclaimer as g } from "./components/Disclaimer/Disclaimer.js";
-import { EmptyView as b } from "./components/EmptyView/EmptyView.js";
-import { Filter as C } from "./components/Filter/Filter.js";
-import { FormattedNumberDisplay as B } from "./components/FormattedNumberDisplay/FormattedNumberDisplay.js";
-import { GenericTable as D } from "./components/GenericTable/GenericTable.js";
-import { HashTabView as k } from "./components/HashTabView/HashTabView.js";
-import { HeaderFilter as M } from "./components/HeaderFilter/HeaderFilter.js";
-import { HealthCheckFailed as E } from "./components/HealthCheckFailed/HealthCheckFailed.js";
+import { ChipCard as A } from "./components/ChipCard/ChipCard.js";
+import { ContextMenu as n } from "./components/ContextMenu/ContextMenu.js";
+import { DeleteModal as d } from "./components/DeleteModal/DeleteModal.js";
+import { Disclaimer as G } from "./components/Disclaimer/Disclaimer.js";
+import { EmptyView as s } from "./components/EmptyView/EmptyView.js";
+import { Filter as F } from "./components/Filter/Filter.js";
+import { FormattedNumberDisplay as N } from "./components/FormattedNumberDisplay/FormattedNumberDisplay.js";
+import { GenericTable as C } from "./components/GenericTable/GenericTable.js";
+import { HashTabView as u } from "./components/HashTabView/HashTabView.js";
+import { HeaderFilter as T } from "./components/HeaderFilter/HeaderFilter.js";
+import { HealthCheckFailed as U } from "./components/HealthCheckFailed/HealthCheckFailed.js";
 import { Iconify as H } from "./components/Iconify/Iconify.js";
 import { InfoGroup as P } from "./components/InfoGroup/InfoGroup.js";
-import { ListArea as y } from "./components/ListArea/ListArea.js";
-import { LoadingSpinner as O } from "./components/LoadingSpinner/Default/LoadingSpinner.js";
-import { Modal as _ } from "./components/Modal/Modal.js";
-import { ModulePadding as U } from "./components/ModulePadding/ModulePadding.js";
-import { OverflowTooltip as Y } from "./components/OverflowTooltip/OverflowTooltip.js";
-import { ScrollbarX as q, ScrollbarY as J } from "./components/Scrollbar/Scrollbar.js";
+import { ListArea as R } from "./components/ListArea/ListArea.js";
+import { LoadingSpinner as w } from "./components/LoadingSpinner/Default/LoadingSpinner.js";
+import { Modal as v } from "./components/Modal/Modal.js";
+import { ModulePadding as Y } from "./components/ModulePadding/ModulePadding.js";
+import { OverflowTooltip as z } from "./components/OverflowTooltip/OverflowTooltip.js";
+import { ScrollbarX as j, ScrollbarY as q } from "./components/Scrollbar/Scrollbar.js";
 import { SearchBar as Q } from "./components/SearchBar/SearchBar.js";
 import { Select as Z } from "./components/Select/Select.js";
 import { VerticalDivider as rr } from "./components/VerticalDivider/VerticalDivider.js";
@@ -30,55 +30,62 @@ import { FormDatePicker as mr } from "./components/FormComponents/FormDatePicker
 import { FormNumber as fr } from "./components/FormComponents/FormNumber/FormNumber.js";
 import { FormRadio as ir } from "./components/FormComponents/FormRadio/FormRadio.js";
 import { FormSelect as lr } from "./components/FormComponents/FormSelect/FormSelect.js";
-import { FormSlider as nr } from "./components/FormComponents/FormSlider/FormSlider.js";
-import { FormText as sr } from "./components/FormComponents/FormText/FormText.js";
-import { FormToggle as Sr } from "./components/FormComponents/FormToggle/FormToggle.js";
-import { AvailableCustomIcons as ur } from "./enums/AvailableCustomIcons.js";
-import { ThemeColor as Ar } from "./enums/ThemeColor.js";
-import { u as hr } from "./useBreakpoints-MzTZ0tCT.js";
-import { capitalizeFirstLetters as Tr, getNumberAsLocaleString as Dr, trimLeadingAndTrailingSpaces as Lr } from "./services/UtilService.js";
-import { LANGUAGE_CODES_MAPPER as wr } from "./types/Languages.js";
+import { FormSlider as cr } from "./components/FormComponents/FormSlider/FormSlider.js";
+import { FormText as Lr } from "./components/FormComponents/FormText/FormText.js";
+import { FormToggle as Er } from "./components/FormComponents/FormToggle/FormToggle.js";
+import { AvailableCustomIcons as Sr } from "./enums/AvailableCustomIcons.js";
+import { ThemeColor as _r } from "./enums/ThemeColor.js";
+import { u as Ir } from "./useBreakpoints-MzTZ0tCT.js";
+import { capitalizeFirstLetters as Dr, getNumberAsLocaleString as Cr, trimLeadingAndTrailingSpaces as gr } from "./services/UtilService.js";
+import { AVAILABLE_COUNTRY_KEYS as Br, AVAILABLE_LOCALES as Tr, ENGLISH_LANGUAGE_ID as br, GERMAN_LANGUAGE_ID as Ur, LANGUAGE_CODES_MAPPER as hr, LANGUAGE_ID_MAPPER as Hr, SPANISH_LANGUAGE_ID as Mr, TURKISH_LANGUAGE_ID as Pr } from "./types/Languages.js";
 export {
+  Br as AVAILABLE_COUNTRY_KEYS,
+  Tr as AVAILABLE_LOCALES,
   t as AlertBanner,
-  ur as AvailableCustomIcons,
+  Sr as AvailableCustomIcons,
   p as BaseView,
   x as BasicHeading,
   a as BlockView,
-  c as ChipCard,
-  d as ContextMenu,
-  F as DeleteModal,
-  g as Disclaimer,
-  b as EmptyView,
-  C as Filter,
+  A as ChipCard,
+  n as ContextMenu,
+  d as DeleteModal,
+  G as Disclaimer,
+  br as ENGLISH_LANGUAGE_ID,
+  s as EmptyView,
+  F as Filter,
   er as FormCheckBox,
   mr as FormDatePicker,
   fr as FormNumber,
   ir as FormRadio,
   lr as FormSelect,
-  nr as FormSlider,
-  sr as FormText,
-  Sr as FormToggle,
-  B as FormattedNumberDisplay,
-  D as GenericTable,
-  k as HashTabView,
-  M as HeaderFilter,
-  E as HealthCheckFailed,
+  cr as FormSlider,
+  Lr as FormText,
+  Er as FormToggle,
+  N as FormattedNumberDisplay,
+  Ur as GERMAN_LANGUAGE_ID,
+  C as GenericTable,
+  u as HashTabView,
+  T as HeaderFilter,
+  U as HealthCheckFailed,
   H as Iconify,
   P as InfoGroup,
-  wr as LANGUAGE_CODES_MAPPER,
-  y as ListArea,
-  O as LoadingSpinner,
-  _ as Modal,
-  U as ModulePadding,
-  Y as OverflowTooltip,
-  q as ScrollbarX,
-  J as ScrollbarY,
+  hr as LANGUAGE_CODES_MAPPER,
+  Hr as LANGUAGE_ID_MAPPER,
+  R as ListArea,
+  w as LoadingSpinner,
+  v as Modal,
+  Y as ModulePadding,
+  z as OverflowTooltip,
+  Mr as SPANISH_LANGUAGE_ID,
+  j as ScrollbarX,
+  q as ScrollbarY,
   Q as SearchBar,
   Z as Select,
-  Ar as ThemeColor,
+  Pr as TURKISH_LANGUAGE_ID,
+  _r as ThemeColor,
   rr as VerticalDivider,
-  Tr as capitalizeFirstLetters,
-  Dr as getNumberAsLocaleString,
-  Lr as trimLeadingAndTrailingSpaces,
-  hr as useBreakpoints
+  Dr as capitalizeFirstLetters,
+  Cr as getNumberAsLocaleString,
+  gr as trimLeadingAndTrailingSpaces,
+  Ir as useBreakpoints
 };

package/dist/services/UtilService.d.ts

@@ -1,4 +1,4 @@
-import { LANGUAGE_CODES } from '../types/Languages';
+import { AVAILABLE_LANGUAGE_CODES } from '../types/Languages';
 
 /**
  * Capitalizes the first letter of every word in a given text string
@@ -22,4 +22,4 @@ export declare const trimLeadingAndTrailingSpaces: <T extends Record<string, unk
  * @param maximumFractionDigits - The maximum number of decimal digits (default is 2).
  * @returns The language-specific formatted number.
  */
-export declare const getNumberAsLocaleString: (locale: LANGUAGE_CODES, value?: number, maximumFractionDigits?: number) => string;
+export declare const getNumberAsLocaleString: (locale: AVAILABLE_LANGUAGE_CODES, value?: number, maximumFractionDigits?: number) => string;

package/dist/types/Languages.d.ts

@@ -1,3 +1,96 @@
-export type LANGUAGE_COUNTRY_CODES = 'de-DE' | 'es-MX' | 'fr-FR' | 'en-US' | 'de-CH';
-export type LANGUAGE_CODES = 'es' | 'en';
-export declare const LANGUAGE_CODES_MAPPER: Record<LANGUAGE_CODES, LANGUAGE_COUNTRY_CODES>;
+/**
+ * HortiView platform english language id
+ */
+export declare const ENGLISH_LANGUAGE_ID = "bb8077e3-ad50-4c1d-8b17-b768b1c9f041";
+/**
+ * HortiView platform german language id
+ */
+export declare const GERMAN_LANGUAGE_ID = "bb8077e3-ad50-4c1d-8b17-b768b1c9f055";
+/**
+ * HortiView platform spanish language id
+ */
+export declare const SPANISH_LANGUAGE_ID = "bb8077e3-ad50-4c1d-8b17-b768b1c9f149";
+/**
+ * HortiView platform turkish language id
+ */
+export declare const TURKISH_LANGUAGE_ID = "bb8077e3-ad50-4c1d-8b17-b768b1c9f166";
+/**
+ * Language id mapper for the HortiView platform
+ * @description
+ * It is a record object that maps the available language codes to the available language ids.
+ * The available language ids are:
+ * - English (en) mapped to {@link ENGLISH_LANGUAGE_ID}
+ * - Spanish (es) mapped to {@link SPANISH_LANGUAGE_ID}
+ * - Turkish (tr) mapped to {@link TURKISH_LANGUAGE_ID}
+ *
+ * @example
+ * ```ts
+ * const languageCode = 'en' as AVAILABLE_LANGUAGE_CODES;
+ * const languageId = LANGUAGE_ID_MAPPER[languageCode];
+ * console.log(languageId); // 'bb8077e3-ad50-4c1d-8b17-b768b1c9f041'
+ * ```
+ */
+export declare const LANGUAGE_ID_MAPPER: {
+    en: string;
+    es: string;
+    tr: string;
+};
+/**
+ * Available languages for the HortiView platform
+ * @description
+ * It is a constant array of the available language codes in ISO 639-1:2002 format (2-digit).
+ * The available languages are:
+ *
+ * - English (en)
+ * - Spanish (es)
+ * - Turkish (tr)
+ */
+export declare const AVAILABLE_LOCALES: readonly ["en", "es", "tr"];
+/**
+ * Available language country codes for the HortiView platform
+ * @description
+ * It is a literal string type of the available language country codes in the format language-country, like 'en-US'.
+ * The available language country codes are:
+ * - English (en-US)
+ * - Spanish (es-MX)
+ * - Turkish (tr-TR)
+ */
+export type LANGUAGE_COUNTRY_CODES = 'es-MX' | 'en-US' | 'tr-TR';
+/**
+ * Available languages for the HortiView platform
+ * @description
+ * It is a literal string type of the available languages in in ISO 639-1:2002 format (2-digit). It is based in {@link AVAILABLE_LOCALES}.
+ * The available language country codes are:
+ * - English (en)
+ * - Spanish (es)
+ * - Turkish (tr)
+ */
+export type AVAILABLE_LANGUAGE_CODES = (typeof AVAILABLE_LOCALES)[number];
+/**
+ * Language codes mapper for the HortiView platform
+ * @description
+ * It is a record object that maps the available language codes to the available language country codes.
+ * The available language country codes are:
+ * - English (en) mapped to 'en-US'
+ * - Spanish (es) mapped to 'es-MX'
+ * - Turkish (tr) mapped to 'tr-TR'
+ *
+ * @example
+ * ```ts
+ * const languageCode = 'en' as AVAILABLE_LANGUAGE_CODES;
+ * const languageCountryCode = LANGUAGE_CODES_MAPPER[languageCode];
+ * console.log(languageCountryCode); // 'en-US'
+ * ```
+ */
+export declare const LANGUAGE_CODES_MAPPER: Record<AVAILABLE_LANGUAGE_CODES, LANGUAGE_COUNTRY_CODES>;
+/**
+ * Available country keys for the HortiView platform
+ * @description
+ * It is a constant array of the available country keys in ISO 3166-1 alpha-3 format (3-digit).
+ * The available country keys are:
+ *
+ * - Spain (esp)
+ * - Mexico (mex)
+ * - Turkey (tur)
+ */
+export declare const AVAILABLE_COUNTRY_KEYS: string[];

package/dist/types/Languages.js

@@ -1,7 +1,24 @@
-const e = {
+const A = "bb8077e3-ad50-4c1d-8b17-b768b1c9f041", e = "bb8077e3-ad50-4c1d-8b17-b768b1c9f055", b = "bb8077e3-ad50-4c1d-8b17-b768b1c9f149", c = "bb8077e3-ad50-4c1d-8b17-b768b1c9f166", E = {
+  en: A,
+  es: b,
+  tr: c
+}, _ = [
+  "en",
+  "es",
+  "tr"
+  // 'de' currently not supported
+], t = {
   en: "en-US",
-  es: "es-MX"
-};
+  es: "es-MX",
+  tr: "tr-TR"
+}, G = ["esp", "mex", "tur"];
 export {
-  e as LANGUAGE_CODES_MAPPER
+  G as AVAILABLE_COUNTRY_KEYS,
+  _ as AVAILABLE_LOCALES,
+  A as ENGLISH_LANGUAGE_ID,
+  e as GERMAN_LANGUAGE_ID,
+  t as LANGUAGE_CODES_MAPPER,
+  E as LANGUAGE_ID_MAPPER,
+  b as SPANISH_LANGUAGE_ID,
+  c as TURKISH_LANGUAGE_ID
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hortiview/shared-components",
   "description": "This is a shared component library. It should used in the HortiView platform and its modules.",
-  "version": "0.0.11747",
+  "version": "0.0.11881",
   "type": "module",
   "repository": "https://dev.azure.com/sdundc/HV%20Platform/_git/HortiView-Frontend-Shared",
   "author": "Falk Menge <falk.menge.ext@bayer.com>",