@beinformed/ui 1.65.13 → 1.65.14

package/src/hooks/__tests__/useModularUIBasic.spec.js

@@ -1,126 +0,0 @@
-import configureMockStore from "redux-mock-store";
-import thunk from "redux-thunk";
-import { Provider } from "react-redux";
-import { renderHook } from "@testing-library/react";
-import xhrMock from "xhr-mock";
-
-import { useModularUIBasic } from "../useModularUIBasic";
-import { ApplicationModel, Href } from "../../models";
-import { useLocation } from "react-router";
-
-const middlewares = [thunk];
-const mockStore = configureMockStore(middlewares);
-
-jest.mock("react-router", () => ({
-  ...jest.requireActual("react-router"), // Keep other methods from react-router as is
-  useLocation: jest.fn(), // Mock useLocation
-}));
-
-const JSON_TYPE = "application/json";
-
-describe("modularui hooks", () => {
-  // replace the real XHR object with the mock XHR object before each test
-  // eslint-disable-next-line jest/no-hooks
-  beforeEach(() => {
-    useLocation.mockReturnValue({
-      state: null,
-    });
-    xhrMock.setup();
-  });
-
-  // put the real XHR object back and clear the mocks after each test
-  // eslint-disable-next-line jest/no-hooks
-  afterEach(() => xhrMock.teardown());
-
-  it("useModularUIBasic", () => {
-    expect.assertions(2);
-
-    xhrMock.get("/BeInformed/", (req, res) => {
-      expect(req.header("accept")).toBe(JSON_TYPE);
-      expect(req.header("Content-Type")).toBe(JSON_TYPE);
-      return res.status(200).body({ data: "ok" });
-    });
-
-    const store = mockStore({
-      modularui: {},
-      router: { location: {} },
-      i18n: { locale: "en" },
-    });
-    /**
-     */
-    const wrapper = ({ children }) => (
-      <Provider store={store}>{children}</Provider>
-    );
-
-    const { result } = renderHook(
-      () =>
-        useModularUIBasic("app", "/", {
-          expectedModels: ["Application"],
-          targetModel: ApplicationModel,
-        }),
-      {
-        wrapper,
-      },
-    );
-
-    expect(result.current).toBeNull();
-
-    expect(store.getActions()).toStrictEqual([
-      { type: "START_PROGRESS" },
-      {
-        type: "MODULARUI/FETCH",
-        payload: expect.objectContaining({
-          href: new Href("/"),
-          locale: "en",
-          targetModel: ApplicationModel,
-        }),
-      },
-    ]);
-  });
-
-  it("useModularUIBasic with reload", () => {
-    expect.assertions(2);
-
-    xhrMock.get("/BeInformed/", (req, res) => {
-      expect(req.header("accept")).toBe(JSON_TYPE);
-      expect(req.header("Content-Type")).toBe(JSON_TYPE);
-      return res.status(200).body({ data: "ok" });
-    });
-
-    const store = mockStore({
-      modularui: {},
-      router: { location: { pathname: "/", state: { reload: true } } },
-      i18n: { locale: "en" },
-    });
-    /**
-     */
-    const wrapper = ({ children }) => (
-      <Provider store={store}>{children}</Provider>
-    );
-
-    const { result } = renderHook(
-      () =>
-        useModularUIBasic("app", "/", {
-          expectedModels: ["Application"],
-          targetModel: ApplicationModel,
-        }),
-      {
-        wrapper,
-      },
-    );
-
-    expect(result.current).toBeNull();
-
-    expect(store.getActions()).toStrictEqual([
-      { type: "START_PROGRESS" },
-      {
-        type: "MODULARUI/FETCH",
-        payload: expect.objectContaining({
-          href: new Href("/"),
-          locale: "en",
-          targetModel: ApplicationModel,
-        }),
-      },
-    ]);
-  });
-});

package/src/hooks/__tests__/useNotification.spec.js

@@ -1,47 +0,0 @@
-import configureMockStore from "redux-mock-store";
-import { Provider } from "react-redux";
-import { renderHook } from "@testing-library/react";
-import { useNotification } from "../useNotification";
-
-const mockStore = configureMockStore();
-
-describe("notification hooks", () => {
-  it("useNotification", () => {
-    const store = mockStore({
-      notification: {
-        render: true,
-        messageType: "notification",
-        message: {
-          id: "notification",
-          defaultMessage: "message",
-        },
-        error: null,
-      },
-    });
-
-    /**
-     */
-    const wrapper = ({ children }) => (
-      <Provider store={store}>{children}</Provider>
-    );
-
-    const { result } = renderHook(() => useNotification(), {
-      wrapper,
-    });
-
-    expect(result.current.render).toBe(true);
-    expect(result.current.messageType).toBe("notification");
-    expect(result.current.message.id).toBe("notification");
-    expect(result.current.message.defaultMessage).toBe("message");
-
-    expect(typeof result.current.dismiss).toBe("function");
-
-    result.current.dismiss();
-
-    expect(store.getActions()).toStrictEqual([
-      {
-        type: "DISMISS_NOTIFICATION",
-      },
-    ]);
-  });
-});

package/src/hooks/__tests__/usePreference.spec.js

@@ -1,72 +0,0 @@
-import configureMockStore from "redux-mock-store";
-import { Provider } from "react-redux";
-import { renderHook } from "@testing-library/react";
-import { usePreference } from "../usePreference";
-
-const mockStore = configureMockStore();
-
-describe("preferences hooks", () => {
-  it("usePreference - exist", () => {
-    const store = mockStore({
-      preferences: {
-        name: "value",
-      },
-    });
-
-    /**
-     */
-    const wrapper = ({ children }) => (
-      <Provider store={store}>{children}</Provider>
-    );
-
-    const { result } = renderHook(() => usePreference("name"), {
-      wrapper,
-    });
-
-    expect(result.current.name).toBe("value");
-  });
-
-  it("usePreference - multiple", () => {
-    const store = mockStore({
-      preferences: {
-        name1: "value1",
-        name2: "value2",
-      },
-    });
-
-    /**
-     */
-    const wrapper = ({ children }) => (
-      <Provider store={store}>{children}</Provider>
-    );
-
-    const { result } = renderHook(
-      () => usePreference(["name1", "name2", "name3"]),
-      {
-        wrapper,
-      },
-    );
-
-    expect(result.current).toStrictEqual({ name1: "value1", name2: "value2" });
-  });
-
-  it("usePreference not existing", () => {
-    const store = mockStore({
-      preferences: {
-        name: "value",
-      },
-    });
-
-    /**
-     */
-    const wrapper = ({ children }) => (
-      <Provider store={store}>{children}</Provider>
-    );
-
-    const { result } = renderHook(() => usePreference("not-existing"), {
-      wrapper,
-    });
-
-    expect(result.current.name).toBeUndefined();
-  });
-});

package/src/hooks/__tests__/useProgressIndicator.spec.js

@@ -1,67 +0,0 @@
-import configureMockStore from "redux-mock-store";
-import { Provider } from "react-redux";
-import { renderHook } from "@testing-library/react";
-import { useProgressIndicator } from "../useProgressIndicator";
-
-const mockStore = configureMockStore();
-
-describe("progressindicator hooks", () => {
-  it("useProgressIndicator", () => {
-    const store = mockStore({
-      progressindicator: {},
-    });
-
-    /**
-     */
-    const wrapper = ({ children }) => (
-      <Provider store={store}>{children}</Provider>
-    );
-
-    const { result } = renderHook(() => useProgressIndicator(), {
-      wrapper,
-    });
-
-    expect(typeof result.current.start).toBe("function");
-    expect(typeof result.current.finish).toBe("function");
-    expect(typeof result.current.reset).toBe("function");
-    expect(typeof result.current.update).toBe("function");
-
-    result.current.start();
-
-    expect(store.getActions()).toStrictEqual([
-      {
-        type: "START_PROGRESS",
-      },
-    ]);
-
-    store.clearActions();
-    result.current.finish();
-
-    expect(store.getActions()).toStrictEqual([
-      {
-        type: "FINISH_PROGRESS",
-      },
-    ]);
-
-    store.clearActions();
-    result.current.reset();
-
-    expect(store.getActions()).toStrictEqual([
-      {
-        type: "RESET_PROGRESS",
-      },
-    ]);
-
-    store.clearActions();
-    result.current.update(50);
-
-    expect(store.getActions()).toStrictEqual([
-      {
-        type: "UPDATE_PROGRESS",
-        payload: {
-          percentComplete: 50,
-        },
-      },
-    ]);
-  });
-});

package/src/hooks/index.js

@@ -1,21 +0,0 @@
-// @flow
-export * from "./useAllFormsOnModel";
-export * from "./useAuthentication";
-export * from "./useContent";
-export * from "./useForm";
-export * from "./useI18n";
-export * from "./useList";
-export * from "./useLookup";
-export * from "./useModal";
-export * from "./useModelCatalog";
-export * from "./useModels";
-export * from "./useModularUI";
-export * from "./useModularUIBasic";
-export * from "./useModularUIModel";
-export * from "./useModularUIRequest";
-export * from "./useNotification";
-export * from "./usePanel";
-export * from "./usePreference";
-export * from "./useProgressIndicator";
-export * from "./useRouter";
-export * from "./useSearch";

package/src/hooks/useAllFormsOnModel.js

@@ -1,92 +0,0 @@
-// @flow
-import { useState, useEffect } from "react";
-
-import { useModularUIRequest } from "./useModularUIRequest";
-
-import { HTTP_METHODS } from "../constants";
-
-import ListModel from "../models/list/ListModel";
-import FormModel from "../models/form/FormModel";
-
-import type DetailModel from "../models/detail/DetailModel";
-import type TabModel from "../models/tab/TabModel";
-import type ActionModel from "../models/actions/ActionModel";
-
-/**
- * Retrieve all forms configured on a model with actions
- * @param model
- * @returns Object - { actionName: FormModel }
- */
-export const useRetrieveFormsOnModel = (
-  model: ListModel | DetailModel | TabModel,
-): null | { [actionName: string]: FormModel } => {
-  const modularui = useModularUIRequest();
-  const [forms, setForms] = useState(null);
-  const [requestCount, setRequestCount] = useState(0);
-  const [responseCount, setResponseCount] = useState(0);
-
-  useEffect(() => {
-    const requests = getActions(model).map((action) => {
-      const href = action.selfhref.addParameter("commit", "false");
-
-      return modularui(href, { method: HTTP_METHODS.POST })
-        .fetch()
-        .then((form) => {
-          if (form instanceof FormModel) {
-            form.tokens = [];
-          }
-          return { [action.name]: form };
-        });
-    });
-
-    setRequestCount(requests.length);
-
-    Promise.all(requests).then((responses) => {
-      // put response array in object
-      const actionForms = Object.assign({}, ...responses);
-      setForms(actionForms);
-      setResponseCount(responses.length);
-    });
-  }, [model, modularui]);
-
-  if (responseCount === requestCount) {
-    return forms;
-  }
-
-  return null;
-};
-
-const getActions = (
-  model: ListModel | DetailModel | TabModel,
-): Array<ActionModel> => {
-  if (!model.actionCollection) {
-    return [];
-  }
-
-  const createActions = model.actionCollection
-    .getActionsByType("create")
-    .filter((action) => !action.isDisabled);
-
-  const allActions = [...createActions];
-
-  if (model instanceof ListModel) {
-    model.listItemCollection.forEach((listItem) => {
-      const updateActions = listItem.actionCollection
-        .getActionsByType("update")
-        .filter((action) => !action.isDisabled);
-
-      allActions.push(...updateActions);
-    });
-  }
-
-  const actions = [];
-  const unique = [];
-  allActions.forEach((action) => {
-    if (!unique.includes(action.name)) {
-      unique.push(action.name);
-      actions.push(action);
-    }
-  });
-
-  return actions;
-};

package/src/hooks/useAuthentication.js

@@ -1,113 +0,0 @@
-// @flow
-import { useSelector, useDispatch } from "react-redux";
-
-import { login, logout, resetAuthErrors } from "../redux/actions";
-
-import Cache from "../utils/browser/Cache";
-import {
-  getBasePath,
-  getBasePathServer,
-  INTERNAL_LOGIN_TYPE,
-} from "../constants";
-import { IllegalStateException } from "../exceptions";
-import { Authenticate } from "../modularui";
-import { useApplication } from "./useModularUIModel";
-
-import type { ResetAuthErrorsAction } from "../redux/types";
-import type { AuthenticationType } from "../models/types";
-
-type LoginHook = {
-  isAuthenticated: boolean,
-  primaryAuthenticationType: AuthenticationType,
-  authenticationTypes: Array<AuthenticationType>,
-  errorMessage: ?string,
-  resetErrors: () => ResetAuthErrorsAction,
-  login: (username: string, password: string) => void,
-  redirectLogin: (authenticationType: AuthenticationType) => void,
-};
-type LogoutHook = {
-  isAuthenticated: boolean,
-  primaryAuthenticationType: AuthenticationType,
-  authenticationTypes: Array<AuthenticationType>,
-  logout: () => void,
-  logoutUrl: string,
-};
-
-/**
- */
-export const useLogin = (): LoginHook => {
-  Cache.setItem("isRedirectLogin", false);
-
-  const dispatch = useDispatch();
-
-  const application = useApplication();
-  const auth = useSelector((state) => state.auth);
-
-  const isAuthenticated = application?.isLoggedIn ?? false;
-
-  const primaryAuthenticationType = Cache.getItem("primaryAuthenticationType");
-
-  return {
-    isAuthenticated,
-    primaryAuthenticationType:
-      primaryAuthenticationType ?? application?.authenticationTypes[0],
-    authenticationTypes: application?.authenticationTypes ?? [],
-    errorMessage: auth.error,
-    resetErrors: () => dispatch(resetAuthErrors()),
-    login: (username: string, password: string) =>
-      dispatch(login(username, password)),
-    redirectLogin: (authenticationType: AuthenticationType) => {
-      if (Cache.getItem("isRedirectLogin")) {
-        // prevent endless loop in redirects when authentication type can't be redirected
-        throw new IllegalStateException(
-          `Could not redirect to '${
-            authenticationType.authentication
-          }' using url: '${authenticationType.redirectUri ?? ""}'`,
-        );
-      }
-
-      if (!isAuthenticated) {
-        Cache.setItem("isRedirectLogin", true);
-        window.location.assign(
-          `${getBasePathServer()}${authenticationType.redirectUri ?? ""}`,
-        );
-      }
-    },
-  };
-};
-
-/**
- */
-export const useLogout = (): LogoutHook => {
-  const dispatch = useDispatch();
-
-  const application = useApplication();
-
-  const BASE_PATH = getBasePath();
-
-  const authenticate = new Authenticate();
-
-  const primaryAuthenticationType = Cache.getItem("primaryAuthenticationType");
-
-  const isAuthenticated = application?.isLoggedIn ?? false;
-  return {
-    isAuthenticated,
-    primaryAuthenticationType:
-      primaryAuthenticationType ?? application?.authenticationTypes[0],
-    authenticationTypes: application?.authenticationTypes ?? [],
-    logout: () => {
-      const type = authenticate.authenticationType;
-      if (type === INTERNAL_LOGIN_TYPE.PAC4J_INDIRECT) {
-        authenticate.redirectToLogout();
-      } else if (Cache.getItem("isRedirectLogin")) {
-        const origin = window.location.origin;
-        const url = `${authenticate.getLogoutUrl()}?url=${origin}${BASE_PATH}`;
-        Cache.setItem("isRedirectLogin", false);
-        window.location.assign(url);
-      } else {
-        return dispatch(logout());
-      }
-    },
-    logoutUrl: authenticate.getLogoutUrl(),
-  };
-};

package/src/hooks/useContent.js

@@ -1,48 +0,0 @@
-// @flow
-import { useState, useEffect } from "react";
-
-import SourceReferenceCollection from "../models/concepts/SourceReferenceCollection";
-import ModularUIRequest from "../modularui/ModularUIRequest";
-
-import { useProgressIndicator } from "../hooks/useProgressIndicator";
-import { useLocale } from "../hooks/useI18n";
-
-import type ContentModel from "../models/content/ContentModel";
-
-/**
- * Hook to retrieve multiple source references at once
- */
-export const useContentFromSourceReferences = (
-  sourceReferences: SourceReferenceCollection,
-  renderChildSections: boolean,
-): Array<ContentModel> => {
-  const [content, setContent] = useState([]);
-  const localeCode = useLocale();
-
-  const { start, finish } = useProgressIndicator();
-
-  const hrefs = sourceReferences
-    .map((sourceReference) => sourceReference.link.selfhref.href)
-    .filter((href, index, self) => self.indexOf(href) === index)
-    .map((href) => href.toString());
-
-  const allHrefs = JSON.stringify(hrefs);
-  useEffect(() => {
-    const requests = JSON.parse(allHrefs).map((href) => {
-      const modularuiRequest = new ModularUIRequest(href);
-      modularuiRequest.locale = localeCode;
-      return modularuiRequest.fetchContent(renderChildSections);
-    });
-
-    start();
-    Promise.all(requests).then((responseContent) => {
-      setContent(responseContent);
-      finish();
-    });
-
-    // start and finish don't change
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [allHrefs, localeCode, renderChildSections]);
-
-  return content;
-};

package/src/hooks/useDeepCompareEffect.js

@@ -1,50 +0,0 @@
-// @flow
-import { useRef, useEffect } from "react";
-import { dequal as deepEqual } from "dequal/lite";
-
-type Callback = () => void | (() => void);
-type DependencyList = $ReadOnlyArray<any>;
-
-/**
- * Validates that dependencies are used correctly.
- * Deep compare should not be used with empty arrays or no dependencies.
- */
-function checkDeps(deps: DependencyList) {
-  if (process.env.NODE_ENV !== "production") {
-    if (!deps || deps.length === 0) {
-      console.warn(
-        "useDeepCompareEffect should not be used with no dependencies. Use React.useEffect instead.",
-      );
-    }
-  }
-}
-
-const useDeepCompareMemoize = (value: DependencyList): DependencyList => {
-  const ref = useRef<DependencyList>(value);
-
-  // Only update the ref if the deep equality check fails
-  if (!deepEqual(value, ref.current)) {
-    ref.current = value;
-  }
-
-  return ref.current;
-};
-
-/**
- * A version of useEffect that accepts a deep comparison of dependencies.
- */
-export function useDeepCompareEffect(
-  callback: Callback,
-  dependencies: DependencyList,
-): void {
-  if (process.env.NODE_ENV !== "production") {
-    checkDeps(dependencies);
-  }
-
-  // We use the memoized ref as the dependency.
-  // React's shallow check will only trigger when the ref object itself changes.
-  // eslint-disable-next-line react-hooks/exhaustive-deps
-  useEffect(callback, useDeepCompareMemoize(dependencies));
-}
-
-export default useDeepCompareEffect;