@beinformed/ui 1.57.4 → 1.58.0

package/src/hooks/useModelCatalog.js

@@ -1,4 +1,5 @@
 // @flow
+import { useSelector, useDispatch } from "react-redux";
 import { useLocation } from "./useRouter";
 
 import { createHref, filterParameters } from "../utils/helpers/createHref";
@@ -14,8 +15,12 @@ import ContentModel from "../models/content/ContentModel";
 import { useModularUIBasic } from "./useModularUIBasic";
 import { ContentTypeModel } from "../models";
 
+import { getEntryDate } from "../redux/selectors/modelcatalog";
+import { updateEntryDate } from "../redux/actions/EntryDate";
+
 import type Href from "../models/href/Href";
 import type { UseModularUIBasicOptions } from "./useModularUIBasic";
+import type { UpdateEntryDateAction } from "../redux";
 export type SearchFilter = {
   index?: string,
   label?: string,
@@ -42,13 +47,15 @@ export const useConceptIndex = (
   key?: string = "conceptindex",
   options?: UseModularUIBasicOptions<ConceptIndexModel>,
 ): ?ConceptIndexModel => {
+  const { entryDate } = useEntryDate();
   const url = filterParameters(href, [
-    "entryDate",
     "index",
     "label",
     "modelcategory",
     "type",
   ]);
+  url.setParameter("entryDate", entryDate);
+
   return useModularUIBasic(key, url, {
     expectedModels: ["ConceptIndex"],
     targetModel: ConceptIndexModel,
@@ -65,9 +72,11 @@ export const useConceptDetail = (
     ConceptDetailModel | BusinessScenarioModel,
   >,
 ): ?ConceptDetailModel | ?BusinessScenarioModel => {
+  const { entryDate } = useEntryDate();
   const location = useLocation();
 
-  const href = createHref("concepts", concept, location, ["entryDate"]);
+  const href = createHref("concepts", concept, entryDate, location, []);
+
   return useModularUIBasic(key, href, {
     expectedModels: ["ConceptDetail", "BusinessScenario"],
     ...options,
@@ -96,8 +105,11 @@ export const useContentTOC = (
   key?: string = "contenttoc",
   options?: UseModularUIBasicOptions<ContentTOCModel>,
 ): ?ContentTOCModel => {
+  const { entryDate } = useEntryDate();
   const location = useLocation();
-  const href = createHref("content", content, location, ["entryDate"]);
+
+  const href = createHref("content", content, entryDate, location, []);
+
   return useModularUIBasic(key, href, {
     expectedModels: ["ContentTOC"],
     targetModel: ContentTOCModel,
@@ -112,7 +124,10 @@ export const useContent = (
   key?: string = "content",
   options?: UseModularUIBasicOptions<ContentModel>,
 ): ?ContentModel => {
-  const href = createHref("content", contentSection, null, ["entryDate"]);
+  const { entryDate } = useEntryDate();
+
+  const href = createHref("content", contentSection, entryDate, null, []);
+
   return useModularUIBasic(key, href, {
     expectedModels: ["Content"],
     targetModel: ContentModel,
@@ -127,7 +142,10 @@ export const useContentType = (
   key?: string = "contenttypes",
   options?: UseModularUIBasicOptions<ContentTypeModel>,
 ): ?ContentTypeModel => {
-  const href = createHref("contenttypes", contentType, null, ["entryDate"]);
+  const { entryDate } = useEntryDate();
+
+  const href = createHref("contenttypes", contentType, entryDate, null, []);
+
   return useModularUIBasic(key, href, {
     expectedModels: ["ContentType"],
     targetModel: ContentTypeModel,
@@ -177,3 +195,19 @@ export const useContentSearch = (
   const href = getSearchHref("/content", filters);
   return useContentIndex(href, key, options);
 };
+
+/**
+ * Retrieve and update the entrydate for the modelcatalog
+ */
+export const useEntryDate = (): ({
+  entryDate: ISO_DATE,
+  setEntryDate: (entryDate: ISO_DATE) => UpdateEntryDateAction,
+}) => {
+  const dispatch = useDispatch();
+  const entryDate = useSelector(getEntryDate);
+
+  return {
+    entryDate,
+    setEntryDate: (entryDate: ISO_DATE) => dispatch(updateEntryDate(entryDate)),
+  };
+};

package/src/models/concepts/ConceptDetailModel.js

@@ -328,7 +328,7 @@ export default class ConceptDetailModel extends ResourceModel {
   }
 
   /**
-   * Retrieve entrydate
+   * Retrieve modelcatalog.js
    */
   get entryDate(): string | null {
     return this.data.filter?.[TIMEVERSION_FILTER_NAME]?.value ?? null;

package/src/models/concepts/ConceptIndexModel.js

@@ -125,7 +125,7 @@ export default class ConceptIndexModel extends ResourceModel {
   }
 
   /**
-   * Retrieve entrydate of content toc
+   * Retrieve modelcatalog.js of content toc
    */
   get entryDate(): string | null {
     const timeversionFilter = this.filterCollection.getFilterByAttributeKey(

package/src/models/content/ContentModel.js

@@ -104,7 +104,7 @@ export default class ContentModel extends ResourceModel {
   }
 
   /**
-   * Retrieve entrydate of content toc
+   * Retrieve modelcatalog.js of content toc
    */
   get entryDate(): ISO_DATE | null {
     const entryDateFilter = this.filterCollection?.getFilterByAttributeKey(

package/src/models/content/ContentTOCModel.js

@@ -173,7 +173,7 @@ export default class ContentTOCModel extends ResourceModel {
   }
 
   /**
-   * Retrieve entrydate of content toc
+   * Retrieve modelcatalog.js of content toc
    */
   get entryDate(): ISO_DATE | null {
     const timeversionFilter = this.filterCollection.getFilterByAttributeKey(

package/src/models/user/UserServicesModel.js

@@ -2,6 +2,7 @@
 import ResourceModel from "../base/ResourceModel";
 import UserModel from "../user/UserModel";
 import ErrorResponse from "../error/ErrorResponse";
+import Cache from "../../utils/browser/Cache";
 
 import type { ModularUIModel } from "../types";
 import type { ModularUIResponse } from "../../modularui";
@@ -112,7 +113,11 @@ class UserServicesModel extends ResourceModel {
     const hasUser = this.user instanceof UserModel;
 
     const UNSECURE_LINK_COUNT = 3;
-    return this.links.length > UNSECURE_LINK_COUNT || hasUser;
+    return (
+      this.links.length > UNSECURE_LINK_COUNT ||
+      hasUser ||
+      Cache.getItem("basic-ok") === true
+    );
   }
 
   /**

package/src/modularui/Authenticate.js

@@ -158,7 +158,10 @@ class Authenticate {
   doJaasAuthentication(username: string, password: string): Promise<any> {
     return this.initLogin(true).then(() => {
       if (this.isBasicAuthentication) {
-        return this.doBasicAuthentication(username, password);
+        Cache.removeItem("basic-ok");
+        return this.doBasicAuthentication(username, password).then(() => {
+          Cache.addItem("basic-ok", true);
+        });
       }
       return this.doFormLogin(username, password);
     });

package/src/redux/actions/EntryDate.js

@@ -0,0 +1,12 @@
+// @flow
+import type { UpdateEntryDateAction } from "../types";
+
+/**
+ * Update the entry date being used in the modelcatalog
+ */
+export const updateEntryDate = (
+  entryDate: ISO_DATE,
+): UpdateEntryDateAction => ({
+  type: "UPDATE_ENTRYDATE",
+  payload: entryDate,
+});

package/src/redux/actions/index.js

@@ -1,6 +1,7 @@
 // @flow
 export * from "./Application";
 export * from "./Authorization";
+export * from "./EntryDate";
 export * from "./Error";
 export * from "./Form";
 export * from "./FormAttributeSet";

package/src/redux/reducers/ModelCatalogReducer.js

@@ -0,0 +1,46 @@
+// @flow
+import { DateUtil } from "../../utils";
+import Cache from "../../utils/browser/Cache";
+
+import type { Reducer } from "redux";
+import type { ReduxAction, ModelCatalogState } from "../types";
+
+const getQueryParam = (paramName: string): ?string => {
+  if (typeof window !== "undefined") {
+    const urlParams = new URLSearchParams(window.location?.search);
+    return urlParams.get(paramName);
+  }
+  return null;
+};
+
+const initialState: ModelCatalogState = {
+  entryDate:
+    getQueryParam("entryDate") ||
+    Cache.getItem("ModelCatalogEntryDate") ||
+    DateUtil.now(),
+};
+
+/**
+ * Keep track of the entry date for the modelcatalog
+ */
+const ModelCatalogReducer: Reducer<ModelCatalogState, ReduxAction> = (
+  state = initialState,
+  action,
+) => {
+  if (!action) {
+    return state;
+  }
+
+  switch (action.type) {
+    case "UPDATE_ENTRYDATE":
+      Cache.addItem("ModelCatalogEntryDate", action.payload);
+      return {
+        ...state,
+        entryDate: action.payload,
+      };
+    default:
+      return state;
+  }
+};
+
+export default ModelCatalogReducer;

package/src/redux/reducers/createReducer.js

@@ -6,6 +6,7 @@ import { I18nReducer } from "../_i18n/I18nReducer";
 import ModalsReducer from "./ModalsReducer";
 import AuthReducer from "./AuthReducer";
 import ErrorReducer from "./ErrorReducer";
+import ModelCatalogReducer from "./ModelCatalogReducer";
 import NotificationReducer from "./NotificationReducer";
 import ProgressIndicatorReducer from "./ProgressIndicatorReducer";
 import PreferencesReducer from "./PreferencesReducer";
@@ -19,6 +20,7 @@ import type {
   ModalsState,
   ErrorState,
   AuthState,
+  ModelCatalogState,
 } from "../types";
 import type { RouterState } from "../_router/types";
 import type { ModularUIState } from "../_modularui/types";
@@ -29,6 +31,7 @@ type Reducers = {
   error: Reducer<ErrorState, ReduxAction>,
   i18n: Reducer<I18nState, ReduxAction>,
   modals: Reducer<ModalsState, ReduxAction>,
+  modelcatalog: Reducer<ModelCatalogState, ReduxAction>,
   modularui: Reducer<ModularUIState, ReduxAction>,
   notification: Reducer<NotificationState, ReduxAction>,
   preferences: Reducer<PreferencesState, ReduxAction>,
@@ -45,6 +48,7 @@ export const createReducer = (): Reducers => ({
   auth: AuthReducer,
   error: ErrorReducer,
   modals: ModalsReducer,
+  modelcatalog: ModelCatalogReducer,
   notification: NotificationReducer,
   progressindicator: ProgressIndicatorReducer,
   preferences: PreferencesReducer,

package/src/redux/reducers/index.js

@@ -2,6 +2,7 @@
 export * from "./createReducer";
 
 export { default as AuthReducer } from "./AuthReducer";
+export { default as ModelCatalogReducer } from "./ModelCatalogReducer";
 export { default as ErrorReducer } from "./ErrorReducer";
 export { default as ModalsReducer } from "./ModalsReducer";
 export { default as NotificationReducer } from "./NotificationReducer";

package/src/redux/selectors/index.js

@@ -1,2 +1,3 @@
 // @flow
 export * from "./i18n";
+export * from "./modelcatalog";

package/src/redux/selectors/modelcatalog.js

@@ -0,0 +1,11 @@
+// @flow
+import { DateUtil } from "../../utils";
+
+import type { ReduxState } from "../types";
+
+/**
+ * Retrieve entrydate for the model catalog
+ */
+export const getEntryDate = (state: ReduxState): ISO_DATE => {
+  return state.modelcatalog?.entryDate ?? DateUtil.now();
+};

package/src/redux/types.js

@@ -135,6 +135,11 @@ export type UpdateAutosaveAction = {
   },
 };
 
+export type UpdateEntryDateAction = {
+  type: "UPDATE_ENTRYDATE",
+  payload: ISO_DATE,
+};
+
 export type ReduxAction =
   | UpdateStatusAction
   | SetModelAction
@@ -162,6 +167,7 @@ export type ReduxAction =
   | ChangePasswordAction
   | LogoutSuccessAction
   | UpdateAutosaveAction
+  | UpdateEntryDateAction
   | LocationChangeAction
   | PushAction
   | ReplaceAction
@@ -206,11 +212,16 @@ export type ProgressIndicatorState = {
   +percentComplete: number,
 };
 
+export type ModelCatalogState = {
+  entryDate: ISO_DATE,
+};
+
 export type ReduxState = {
   +router: RouterState,
   +modularui: ModularUIState,
   +i18n: I18nState,
   +auth: AuthState,
+  +modelcatalog: ModelCatalogState,
   +error: ErrorState,
   +modals: ModalsState,
   +notification: NotificationState,

package/src/utils/helpers/__tests__/createHref.spec.js

@@ -7,25 +7,29 @@ describe("createHref", () => {
     const location = {
       search: "?entryDate=2024-03-08&index=C&notAllowed=true",
     };
+    const expectedSearch = "?index=C&notAllowed=true&entryDate=2010-01-01";
 
     expect(createHref("concepts", dynamicPart)).toEqual(
       new Href("/concepts/" + dynamicPart),
     );
-    expect(createHref("concepts", dynamicPart, location)).toEqual(
-      new Href("/concepts/" + dynamicPart + location.search),
+    expect(createHref("concepts", dynamicPart, "2010-01-01", location)).toEqual(
+      new Href("/concepts/" + dynamicPart + expectedSearch),
     );
     expect(
-      createHref("concepts", dynamicPart, location, ["entryDate", "index"]),
+      createHref("concepts", dynamicPart, "2010-01-01", location, ["index"]),
     ).toEqual(
-      new Href("/concepts/" + dynamicPart + "?entryDate=2024-03-08&index=C"),
+      new Href("/concepts/" + dynamicPart + "?index=C&entryDate=2010-01-01"),
     );
     expect(
-      createHref("concepts", dynamicPart + location.search, location, [
-        "entryDate",
-        "index",
-      ]),
+      createHref(
+        "concepts",
+        dynamicPart + location.search,
+        "2010-01-01",
+        location,
+        ["index"],
+      ),
     ).toEqual(
-      new Href("/concepts/" + dynamicPart + "?entryDate=2024-03-08&index=C"),
+      new Href("/concepts/" + dynamicPart + "?index=C&entryDate=2010-01-01"),
     );
 
     expect(createHref("concepts", dynamicPart + "#hash")).toEqual(

package/src/utils/helpers/createHref.js

@@ -77,6 +77,7 @@ export const filterParameters = (
 export const createHref = (
   context: string,
   dynamicPart: string | Href,
+  entryDate?: ISO_DATE,
   location?: ?Location,
   allowedParameters?: Array<string>,
 ): Href => {
@@ -95,15 +96,22 @@ export const createHref = (
     href = `${href}?${search}`;
   }
 
-  if (dynamicPart instanceof Href) {
-    return filterParameters(
-      new Href(href, dynamicPart.resourcetype, {
-        origin: dynamicPart.origin,
-        contextPath: dynamicPart.contextPath,
-      }),
-      allowedParameters,
-    );
+  const finalHref =
+    dynamicPart instanceof Href
+      ? filterParameters(
+          new Href(href, dynamicPart.resourcetype, {
+            origin: dynamicPart.origin,
+            contextPath: dynamicPart.contextPath,
+          }),
+          allowedParameters,
+        )
+      : filterParameters(href, allowedParameters);
+
+  if (entryDate) {
+    finalHref.setParameter("entryDate", entryDate);
+  } else {
+    finalHref.removeParameter("entryDate");
   }
 
-  return filterParameters(href, allowedParameters);
+  return finalHref;
 };

package/types/models/concepts/ConceptDetailModel.d.ts

@@ -60,7 +60,7 @@ export default class ConceptDetailModel extends ResourceModel {
      */
     getSourceReferencesForCurrentLanguage(availableLocales: Array<string>): Array<Object>;
     /**
-     * Retrieve entrydate
+     * Retrieve modelcatalog.js
      */
     get entryDate(): string;
     /**

package/types/models/concepts/ConceptIndexModel.d.ts

@@ -13,7 +13,7 @@ export default class ConceptIndexModel extends ResourceModel {
      */
     get indexfilter(): FilterType;
     /**
-     * Retrieve entrydate of content toc
+     * Retrieve modelcatalog.js of content toc
      */
     get entryDate(): string;
     /**

package/types/models/content/ContentModel.d.ts

@@ -27,7 +27,7 @@ export default class ContentModel extends ResourceModel {
      */
     get filterCollection(): FilterCollection;
     /**
-     * Retrieve entrydate of content toc
+     * Retrieve modelcatalog.js of content toc
      */
     get entryDate(): any;
     /**

package/types/models/content/ContentTOCModel.d.ts

@@ -30,7 +30,7 @@ export default class ContentTOCModel extends ResourceModel {
      */
     get filterCollection(): FilterCollection;
     /**
-     * Retrieve entrydate of content toc
+     * Retrieve modelcatalog.js of content toc
      */
     get entryDate(): any;
 }