@beinformed/ui 1.63.2 → 2.0.0-beta.0

package/src/hooks/useNotification.js

@@ -1,48 +0,0 @@
-// @flow
-import { useSelector, useDispatch } from "react-redux";
-import { dismissNotification, showNotification } from "../redux/actions";
-
-import type {
-  DismissNotificationAction,
-  NotificationState,
-  ShowNotificationAction,
-} from "../redux/types";
-
-import { NOTIFICATION_TYPES } from "../constants";
-
-import type { MessageObject } from "../i18n";
-import type ErrorResponse from "../models/error/ErrorResponse";
-type NotificationHook = {
-  ...NotificationState,
-  dismiss: () => DismissNotificationAction,
-};
-type ErrorNotificationHook = (
-  message: MessageObject,
-  error?: ?ErrorResponse,
-) => ShowNotificationAction;
-
-/**
- */
-export const useNotification = (): NotificationHook => {
-  const dispatch = useDispatch();
-  const { render, messageType, message, error } = useSelector(
-    (state) => state.notification,
-  );
-
-  return {
-    render,
-    messageType,
-    message,
-    error,
-    dismiss: () => dispatch(dismissNotification()),
-  };
-};
-
-/**
- */
-export const useErrorNotification = (): ErrorNotificationHook => {
-  const dispatch = useDispatch();
-  return (message: MessageObject, error?: ?ErrorResponse) => {
-    return dispatch(showNotification(NOTIFICATION_TYPES.ERROR, message, error));
-  };
-};

package/src/hooks/usePreference.js

@@ -1,27 +0,0 @@
-// @flow
-import pick from "lodash/pick";
-import { useSelector } from "react-redux";
-import { createSelector } from "reselect";
-
-import type { PreferencesState, ReduxState } from "../redux/types";
-
-const getPreferences = (state: ReduxState) => state.preferences;
-const getPreferenceNames = (
-  state: ReduxState,
-  preferenceNames: string | Array<string>,
-) => (Array.isArray(preferenceNames) ? preferenceNames : [preferenceNames]);
-
-const selectPreference = createSelector(
-  [getPreferences, getPreferenceNames],
-  (preferences, preferenceNames) => {
-    return pick(preferences, preferenceNames);
-  },
-);
-
-/**
- */
-export const usePreference = (
-  preferenceNames: string | Array<string>,
-): PreferencesState => {
-  return useSelector((state) => selectPreference(state, preferenceNames));
-};

package/src/hooks/useProgressIndicator.js

@@ -1,33 +0,0 @@
-// @flow
-import { useDispatch, useSelector } from "react-redux";
-import {
-  startProgress,
-  finishProgress,
-  resetProgress,
-  updateProgress,
-} from "../redux/actions/ProgressIndicator";
-import type { ProgressIndicatorState } from "../redux/types";
-
-type ProgressIndicatorHook = {
-  ...ProgressIndicatorState,
-  start: () => void,
-  finish: () => void,
-  reset: () => void,
-  update: (percentComplete: number) => void,
-};
-
-/**
- */
-export const useProgressIndicator = (): ProgressIndicatorHook => {
-  const dispatch = useDispatch();
-  const progress = useSelector((state) => state.progressindicator);
-
-  return {
-    ...progress,
-    start: () => dispatch(startProgress()),
-    finish: () => dispatch(finishProgress()),
-    reset: () => dispatch(resetProgress()),
-    update: (percentComplete: number) =>
-      dispatch(updateProgress(percentComplete)),
-  };
-};

package/src/hooks/useRouter.js

@@ -1,64 +0,0 @@
-// @flow
-import { useDispatch, useSelector } from "react-redux";
-import type { Location, LocationShape } from "react-router";
-
-import {
-  push,
-  replace,
-  go,
-  goBack,
-  goForward,
-} from "../redux/_router/RouterActions";
-import type {
-  GoAction,
-  GoBackAction,
-  GoForwardAction,
-  PushAction,
-  ReplaceAction,
-} from "../redux";
-
-type UseLocationHook = () => Location;
-type UseLocationKeyHook = () => string;
-type UseQuerystringHook = () => string;
-type UsePathnameHook = () => string;
-type UseNavigationHook = () => {
-  push: (location: LocationShape | string, state?: { ... }) => PushAction,
-  replace: (location: LocationShape | string, state?: { ... }) => ReplaceAction,
-  go: (delta: number) => GoAction,
-  goBack: () => GoBackAction,
-  goForward: () => GoForwardAction,
-};
-
-/**
- */
-export const useLocation: UseLocationHook = () =>
-  useSelector((state) => state.router.location);
-
-/**
- */
-export const useLocationKey: UseLocationKeyHook = () =>
-  useLocation()?.key ?? "";
-
-/**
- */
-export const useQuerystring: UseQuerystringHook = () => useLocation()?.search;
-
-/**
- */
-export const usePathname: UsePathnameHook = () => useLocation()?.pathname;
-
-/**
- */
-export const useNavigation: UseNavigationHook = () => {
-  const dispatch = useDispatch();
-
-  return {
-    push: (location: LocationShape | string, state?: { ... }) =>
-      dispatch(push(location, state)),
-    replace: (location: LocationShape | string, state?: { ... }) =>
-      dispatch(replace(location, state)),
-    go: (delta: number) => dispatch(go(delta)),
-    goBack: () => dispatch(goBack()),
-    goForward: () => dispatch(goForward()),
-  };
-};

package/src/i18n/Locale.js

@@ -1,157 +0,0 @@
-// @flow
-import formatMessage from "format-message";
-
-import languages from "./languages";
-import { IllegalStateException } from "../exceptions";
-
-import { getSetting } from "../constants";
-
-import type { LocaleConfiguration, MessageParameters } from "./types";
-
-/**
- * Create a locale
- */
-class Locale {
-  _code: string;
-  _messages: { [string]: string };
-  _errors: { [string]: string };
-  _nativeName: ?string;
-
-  constructor(locale: LocaleConfiguration) {
-    this._code = locale.code;
-
-    this._messages = this.fixPlaceHoldersInObject(locale.messages);
-    this._errors = this.fixPlaceHoldersInObject(locale.errors);
-
-    this._nativeName = locale.nativeName;
-
-    formatMessage.setup({
-      missingTranslation: "ignore",
-    });
-  }
-
-  /**
-   * Retrieve locale code
-   */
-  get code(): string {
-    return this._code;
-  }
-
-  /**
-   * Retrieve nativeName
-   */
-  get nativeName(): string {
-    if (this._nativeName) {
-      return this._nativeName;
-    }
-
-    const aLocale = this.code.split("-");
-
-    if (aLocale.length > 0) {
-      const language = languages.lang[aLocale[0]];
-
-      if (language) {
-        return (
-          language[1] + (aLocale[1] ? ` (${aLocale[1].toUpperCase()})` : "")
-        );
-      }
-    }
-
-    throw new IllegalStateException(
-      `Can not find language name based on locale: ${this.code}`,
-    );
-  }
-
-  /**
-   * Exported messages from Be Informed have placeholders in the syntax ${placeholder_name}
-   * where the ICU messageformat module uses {placeholder_name}.
-   * This method converts the ${} to {}
-   */
-  fixPlaceHolders(message: ?string): null | string {
-    if (typeof message === "string") {
-      return message
-        .replace(/'\$\{(?<key>.*?)}'/g, "''{$<key>}''")
-        .replace(/\$\{(?<key>.*?)}/g, "{$<key>}");
-    }
-
-    return null;
-  }
-
-  /**
-   * Exported messages from Be Informed have placeholders in the syntax ${placeholder_name}
-   * where the ICU messageformat module uses {placeholder_name}.
-   * This method converts the ${} to {}
-   */
-  fixPlaceHoldersInObject(messages: Object = {}): Object {
-    return JSON.parse(
-      JSON.stringify(messages)
-        .replace(/'\$\{(?<key>.*?)}'/g, "''{$<key>}''")
-        .replace(/\$\{(?<key>.*?)}/g, "{$<key>}"),
-    );
-  }
-
-  /**
-   * Retrieve message by id
-   */
-  getBaseMessage(id: string, defaultMessage?: string): string {
-    if (!id && !defaultMessage) {
-      return "[message: id or defaultMessage missing]";
-    }
-
-    const messageFromLocale = this._messages[id] || this._errors[id];
-
-    if (
-      (typeof process === "undefined" ||
-        process.env.NODE_ENV !== "production") &&
-      !messageFromLocale &&
-      id &&
-      getSetting("DEBUG_I18N_MESSAGE_NOT_FOUND")
-    ) {
-      // eslint-disable-next-line no-console
-      console.debug(
-        `Message with id ${id} not found for locale ${this.code} in layout translations`,
-      );
-    }
-    return messageFromLocale || this.fixPlaceHolders(defaultMessage) || id;
-  }
-
-  /**
-   * Format message using formatMessage library
-   */
-  formatMessage(message: string, parameters?: MessageParameters): string {
-    if (parameters) {
-      return formatMessage(message, parameters);
-    }
-
-    return message;
-  }
-
-  /**
-   * Retrieve a messages with replaced parameters
-   */
-  getMessage(
-    id: string,
-    defaultMessage?: string,
-    parameters?: MessageParameters,
-  ): string {
-    const message = this.getBaseMessage(id, defaultMessage);
-    return this.formatMessage(message, parameters);
-  }
-
-  /**
-   * Add or change messages for this locale. It is not possible to remove messages.
-   */
-  update(messages: Object = {}, errors: Object = {}) {
-    this._messages = {
-      ...this._messages,
-      ...this.fixPlaceHoldersInObject(messages),
-    };
-
-    this._errors = {
-      ...this._errors,
-      ...this.fixPlaceHoldersInObject(errors),
-    };
-  }
-}
-
-export default Locale;

package/src/i18n/Locales.js

@@ -1,171 +0,0 @@
-// @flow
-import Locale from "./Locale";
-
-import englishErrors from "./translations/beinformed_error_messages_en.nl";
-import dutchErrors from "./translations/beinformed_error_messages_nl.nl";
-
-import BaseCollection from "../models/base/BaseCollection";
-
-import { IllegalArgumentException } from "../exceptions";
-
-import type { LocaleConfiguration } from "./types";
-
-type ErrorMessageObject = {
-  [languageCode: string]: {
-    [messageID: string]: string,
-  },
-};
-
-type HydratedLocales = {
-  _collection: Array<{
-    _code: string,
-    _messages: {
-      [string]: string,
-    },
-    _errors: {
-      [string]: string,
-    },
-  }>,
-};
-
-/**
- * Array of available locales
- * Order of locales is the preferred order of locales.
- * When user has an accept language header that does not correspond to the locales array,
- * the first one is used as the preferred language
- */
-export const availableLocales: Array<LocaleConfiguration> = [
-  {
-    code: "en",
-    messages: {},
-    errors: englishErrors,
-  },
-  {
-    code: "nl",
-    messages: {},
-    errors: dutchErrors,
-  },
-];
-
-/**
- * Merge an object with custom error messages (exported and translated from be informed for example) and merge them with the existing translations.
- */
-export const createLocalesWithConfiguredErrors = (
-  configuredErrors: ErrorMessageObject,
-): Array<Object> =>
-  availableLocales.map((availableLocale) => {
-    if (configuredErrors[availableLocale.code]) {
-      return {
-        ...availableLocale,
-        errors: {
-          ...availableLocale.errors,
-          ...configuredErrors[availableLocale.code],
-        },
-      };
-    }
-
-    return availableLocale;
-  });
-
-/**
- * Locales, collection of Locale
- */
-class Locales extends BaseCollection<Locale> {
-  constructor(locales: Array<LocaleConfiguration> = availableLocales) {
-    super(locales.map((locale) => new Locale(locale)));
-  }
-
-  /**
-   * rehydrate
-   */
-  static rehydrate(hydatedLocales: HydratedLocales): Locales {
-    if (hydatedLocales && hydatedLocales._collection) {
-      return new Locales(
-        hydatedLocales._collection.map((locale) => ({
-          code: locale._code,
-          messages: locale._messages,
-          errors: locale._errors,
-        })),
-      );
-    }
-
-    return new Locales([]);
-  }
-
-  /**
-   * Check if locale with localeCode exists
-   */
-  hasLocale(localeCode: string): boolean {
-    return this.some((item) => localeCode.startsWith(item.code));
-  }
-
-  /**
-   * Retrieve locales by localeCode from Locales collection
-   */
-  getLocale(localeCode: string): Locale {
-    if (this.hasLocale(localeCode)) {
-      const locale = this.find((item) => localeCode.startsWith(item.code));
-      if (locale) {
-        return locale;
-      }
-    }
-    throw new IllegalArgumentException(
-      `Locale configuration for locale ${localeCode} not found`,
-    );
-  }
-
-  /**
-   * Retrieve all available locale codes
-   */
-  get availableLocaleCodes(): Array<string> {
-    return this.map((locale) => locale.code);
-  }
-
-  /**
-   * Retrieve preferred locale based on the accept header of a browser
-   */
-  getPreferredLocale(acceptLanguageHeader: string | null): void | string {
-    if (acceptLanguageHeader != null) {
-      const acceptLanguages =
-        acceptLanguageHeader.match(/[-A-Za-z]{2,10}/gu) || [];
-
-      const preferredLocales = acceptLanguages
-        .filter((locale) =>
-          this.availableLocaleCodes.some((availableLocale) =>
-            locale.startsWith(availableLocale),
-          ),
-        )
-        .map((locale) =>
-          this.availableLocaleCodes.find((availableLocale) =>
-            locale.startsWith(availableLocale),
-          ),
-        );
-
-      if (preferredLocales.length > 0) {
-        return preferredLocales[0];
-      }
-    }
-
-    return this.availableLocaleCodes[0];
-  }
-
-  /**
-   * Add or change messages and errors for the given locale.<br>
-   * It is not possible to remove messages.
-   */
-  update(locale: string, messages: Object = {}, errors: Object = {}) {
-    if (this.hasLocale(locale)) {
-      this.getLocale(locale).update(messages, errors);
-    } else {
-      this.add(
-        new Locale({
-          code: locale,
-          messages,
-          errors,
-        }),
-      );
-    }
-  }
-}
-
-export default Locales;

package/src/i18n/Message.js

@@ -1,66 +0,0 @@
-// @flow
-import { memo } from "react";
-import { hideVisually } from "polished";
-
-import { useMessage } from "../hooks/useI18n";
-
-type MessageProps = {
-  +className?: string,
-  +id: string,
-  +defaultMessage?: string | null,
-  +children?: string,
-  +data?: Object | null,
-  +screenreaderOnly?: boolean,
-  +allowHTML?: boolean,
-};
-
-/**
- * Message React component
- */
-const Message: React$AbstractComponent<MessageProps, mixed> =
-  memo<MessageProps>(
-    ({
-      className,
-      id,
-      defaultMessage,
-      children,
-      data,
-      screenreaderOnly = false,
-      allowHTML = false,
-    }: MessageProps) => {
-      const translatedMessage = useMessage(
-        id,
-        defaultMessage || children,
-        data,
-      );
-
-      if (screenreaderOnly) {
-        const styles = {
-          ...hideVisually(),
-        };
-
-        return (
-          <span className={className} style={styles}>
-            {translatedMessage}
-          </span>
-        );
-      }
-
-      if (allowHTML) {
-        return (
-          <span
-            className={className}
-            dangerouslySetInnerHTML={{
-              __html: translatedMessage,
-            }}
-          />
-        );
-      }
-
-      return <span className={className}>{translatedMessage}</span>;
-    },
-  );
-
-Message.displayName = "BI.Message";
-
-export default Message;

package/src/i18n/__tests__/Locale.spec.js

@@ -1,108 +0,0 @@
-import Locale from "../Locale";
-
-import englishErrors from "../translations/beinformed_error_messages_en.nl.js";
-import { IllegalStateException } from "../../exceptions";
-import { setSetting } from "../../constants";
-
-global.console = {
-  warn: jest.fn(),
-  debug: jest.fn(),
-};
-
-jest.mock(
-  "../translations/layout_en.nl.json",
-  () => ({
-    testMessage: "testMessage",
-    messageWithParams: "Param 1: {param1}, Param 2: {param2}",
-    messageWithJavaParams: "Param 1: ${param1}, Param 2: ${param2}", // NOSONAR
-  }),
-  { virtual: true },
-);
-
-describe("locale", () => {
-  it("should be able to give back the native name of a locale", () => {
-    const locale = new Locale({
-      code: "en-US",
-      messages: {},
-      errors: englishErrors,
-    });
-
-    expect(locale.code).toBe("en-US");
-    expect(locale.nativeName).toBe("English (US)");
-
-    expect(locale.getMessage()).toBe("[message: id or defaultMessage missing]");
-    expect(locale.getMessage("testMessage")).toBe("testMessage");
-
-    locale.update({
-      testMessage: "Updated message",
-    });
-
-    expect(locale.getMessage("testMessage")).toBe("Updated message");
-  });
-
-  it("can handle languages without iso-639-2 code", () => {
-    const locale = new Locale({
-      code: "pap",
-      nativeName: "Papiamento",
-      messages: {
-        descr: "Papiamento",
-      },
-      errors: {},
-    });
-
-    expect(locale.code).toBe("pap");
-    expect(locale.nativeName).toBe("Papiamento");
-  });
-
-  it("throws on non exising locale", () => {
-    const locale = new Locale({
-      code: "NONEXISTING",
-    });
-
-    expect(() => {
-      locale.nativeName;
-    }).toThrow(IllegalStateException);
-  });
-
-  it("updates be informed message export to format-message formatted messages", () => {
-    const messages = {
-      code: "Parameter '${parameter}' is niet toegestaan",
-    };
-
-    const locale = new Locale({
-      code: "CUSTOM",
-      messages,
-    });
-
-    expect(locale.fixPlaceHoldersInObject(messages)).toStrictEqual({
-      code: "Parameter ''{parameter}'' is niet toegestaan",
-    });
-
-    expect(
-      locale.getMessage("code", "", {
-        parameter: "parameterName",
-      }),
-    ).toBe("Parameter 'parameterName' is niet toegestaan");
-  });
-
-  it("handle non existing messages", () => {
-    const locale = new Locale({ code: "de" });
-
-    const msg = locale.getMessage("non-existing");
-    expect(msg).toBe("non-existing");
-    expect(global.console.debug).toHaveBeenCalledWith(
-      "Message with id non-existing not found for locale de in layout translations",
-    );
-
-    const msgWithDefault = locale.getMessage("non-existing", "Default");
-    expect(msgWithDefault).toBe("Default");
-
-    global.console.warn.mockClear();
-
-    setSetting("DEBUG_I18N_MESSAGE_NOT_FOUND", false);
-
-    const msgNoWarn = locale.getMessage("non-existing");
-    expect(msgNoWarn).toBe("non-existing");
-    expect(global.console.warn).not.toHaveBeenCalled();
-  });
-});