@beinformed/ui 1.52.2 → 1.54.0

package/src/hooks/useModelCatalog.js

@@ -14,12 +14,23 @@ import ContentModel from "../models/content/ContentModel";
 import { useModularUIBasic } from "./useModularUIBasic";
 import { ContentTypeModel } from "../models";
 
+import type { UseModularUIBasicOptions } from "./useModularUIBasic";
+export type SearchFilter = {
+  index?: string,
+  label?: string,
+  type?: string | Array<string>,
+  entryDate?: string,
+};
+
 /**
  */
-export const useModelCatalog = (): ?ModelCatalogModel =>
+export const useModelCatalog = (
+  options?: UseModularUIBasicOptions<ModelCatalogModel>,
+): ?ModelCatalogModel =>
   useModularUIBasic("modelcatalog", "/modelcatalog", {
     expectedModels: ["ModelCatalog"],
     targetModel: ModelCatalogModel,
+    ...options,
   });
 
 /**
@@ -27,11 +38,13 @@ export const useModelCatalog = (): ?ModelCatalogModel =>
 export const useConceptIndex = (
   href: string,
   key?: string = "conceptindex",
+  options?: UseModularUIBasicOptions<ConceptIndexModel>,
 ): ?ConceptIndexModel => {
   const url = filterParameters(href, ["entryDate", "index", "label", "type"]);
   return useModularUIBasic(key, url, {
     expectedModels: ["ConceptIndex"],
     targetModel: ConceptIndexModel,
+    ...options,
   });
 };
 
@@ -40,12 +53,16 @@ export const useConceptIndex = (
 export const useConceptDetail = (
   concept: string,
   key?: string = "conceptdetail",
+  options?: UseModularUIBasicOptions<
+    ConceptDetailModel | BusinessScenarioModel,
+  >,
 ): ?ConceptDetailModel | ?BusinessScenarioModel => {
   const location = useLocation();
 
   const href = createHref("concepts", concept, location, ["entryDate"]);
   return useModularUIBasic(key, href, {
     expectedModels: ["ConceptDetail", "BusinessScenario"],
+    ...options,
   });
 };
 
@@ -54,11 +71,13 @@ export const useConceptDetail = (
 export const useContentIndex = (
   href: string,
   key?: string = "contentindex",
+  options?: UseModularUIBasicOptions<ContentIndexModel>,
 ): ?ContentIndexModel => {
   const url = filterParameters(href, ["index", "label", "type"]);
   return useModularUIBasic(key, url, {
     expectedModels: ["ContentIndex"],
     targetModel: ContentIndexModel,
+    ...options,
   });
 };
 
@@ -67,12 +86,14 @@ export const useContentIndex = (
 export const useContentTOC = (
   content: string,
   key?: string = "contenttoc",
+  options?: UseModularUIBasicOptions<ContentTOCModel>,
 ): ?ContentTOCModel => {
   const location = useLocation();
   const href = createHref("content", content, location, ["entryDate"]);
   return useModularUIBasic(key, href, {
     expectedModels: ["ContentTOC"],
     targetModel: ContentTOCModel,
+    ...options,
   });
 };
 
@@ -81,11 +102,13 @@ export const useContentTOC = (
 export const useContent = (
   contentSection: string,
   key?: string = "content",
+  options?: UseModularUIBasicOptions<ContentModel>,
 ): ?ContentModel => {
   const href = createHref("content", contentSection, null, ["entryDate"]);
   return useModularUIBasic(key, href, {
     expectedModels: ["Content"],
     targetModel: ContentModel,
+    ...options,
   });
 };
 
@@ -94,10 +117,55 @@ export const useContent = (
 export const useContentType = (
   contentType: string,
   key?: string = "contenttypes",
+  options?: UseModularUIBasicOptions<ContentTypeModel>,
 ): ?ContentTypeModel => {
   const href = createHref("contenttypes", contentType, null, ["entryDate"]);
   return useModularUIBasic(key, href, {
     expectedModels: ["ContentType"],
     targetModel: ContentTypeModel,
+    ...options,
   });
 };
+
+/**
+ */
+const getSearchHref = (uri: string, filters: SearchFilter): string => {
+  const filterString = [];
+
+  for (const key of Object.keys(filters)) {
+    const filterValue = filters[key];
+    if (filterValue) {
+      let value: string = Array.isArray(filterValue)
+        ? filterValue.join(",")
+        : filterValue;
+      if (key === "type") {
+        value = value.replace("#", "%23"); // handles un-encoded #
+      }
+      filterString.push(`${key}=${value}`);
+    }
+  }
+
+  return filterString.length ? `${uri}?${filterString.join("&")}` : uri;
+};
+
+/**
+ */
+export const useConceptSearch = (
+  filters: SearchFilter,
+  key?: string = "conceptSearch",
+  options?: UseModularUIBasicOptions<ConceptIndexModel>,
+): ?ConceptIndexModel => {
+  const href = getSearchHref("/concepts", filters);
+  return useConceptIndex(href, key, options);
+};
+
+/**
+ */
+export const useContentSearch = (
+  filters: SearchFilter,
+  key?: string = "contentSearch",
+  options?: UseModularUIBasicOptions<ContentIndexModel>,
+): ?ContentIndexModel => {
+  const href = getSearchHref("/content", filters);
+  return useContentIndex(href, key, options);
+};

package/src/hooks/useModularUIBasic.js

@@ -7,10 +7,11 @@ import { IllegalStateException } from "../exceptions";
 
 import type { ModularUIModel, Href } from "../models";
 
-type UseModularUIBasicOptions<T: ModularUIModel> = {
+export type UseModularUIBasicOptions<T: ModularUIModel> = {
   expectedModels: Array<string>,
   targetModel?: Class<T> | Array<Class<T>>,
   forceTargetModel?: boolean,
+  cache?: boolean,
 };
 
 /**
@@ -30,12 +31,17 @@ export const useModularUIBasic = <T: ModularUIModel>(
     targetModel: undefined,
     forceTargetModel: undefined,
     isReload: false,
+    cache: false,
   };
   if (options.targetModel) {
     useModularUIOptions.targetModel = options.targetModel;
     useModularUIOptions.forceTargetModel = options.forceTargetModel;
   }
 
+  if (options.cache) {
+    useModularUIOptions.cache = options.cache;
+  }
+
   // reload when the modular service starts with the current location
   if (location.state?.reload && location.pathname.startsWith(href.toString())) {
     useModularUIOptions.isReload = true;

package/src/redux/_modularui/ModularUIActions.js

@@ -116,6 +116,7 @@ export const loadModel = (
     childmodels: options?.childmodels,
     targetModel: options?.targetModel,
     forceTargetModel: options?.forceTargetModel,
+    cache: options?.cache,
     /**
      */
     successAction: (model) =>

package/src/redux/_modularui/ModularUIMiddleware.js

@@ -27,6 +27,7 @@ type RequestOptions = {
   targetModel?: TargetModel,
   forceTargetModel?: boolean,
   isReload?: boolean,
+  cache?: boolean,
 };
 
 /**
@@ -39,6 +40,7 @@ const createRequest = (modularui: RequestOptions): ModularUIRequest => {
     locale: modularui.locale,
     childmodels: modularui.childmodels ?? true,
     isReload: modularui.isReload,
+    cache: modularui.cache,
   });
 
   if (modularui.targetModel) {

package/src/redux/_modularui/types.js

@@ -72,6 +72,7 @@ export type ModularUIAction = {
     childmodels?: boolean,
     targetModel?: TargetModel,
     forceTargetModel?: boolean,
+    cache?: boolean,
     successAction: (
       model: ModularUIModel,
     ) => UpdateModelAction | SetModelAction,

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

@@ -60,9 +60,17 @@ export default class ConceptDetailModel extends ResourceModel {
      */
     getSourceReferencesForCurrentLanguage(availableLocales: Array<string>): Array<Object>;
     /**
-     * Retrieve entrydate of content toc
+     * Retrieve entrydate
      */
     get entryDate(): string;
+    /**
+     * Indicates if the given concept type id or href exists in the hierarchy of concept types for this concept
+     */
+    isOfConceptType(conceptTypeId: string): boolean;
+    /**
+     * Indicates if the given metamodel functional identifier exists in the hierarchy of concept types for this concept
+     */
+    hasMetamodelIdInConceptTypeHierarchy(metamodelId: string): boolean;
 }
 import ResourceModel from "../base/ResourceModel";
 import ConceptRelationCollection from "./ConceptRelationCollection";

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

@@ -56,6 +56,14 @@ export default class ConceptLinkModel extends BaseModel {
     /**
      */
     asLinkModel(): LinkModel;
+    /**
+     * Indicates if the given concept type id or href exists in the hierarchy of concept types for this concept
+     */
+    isOfConceptType(conceptTypeId: string): boolean;
+    /**
+     * Indicates if the given metamodel functional identifier exists in the hierarchy of concept types for this concept
+     */
+    hasMetamodelIdInConceptTypeHierarchy(metamodelId: string): boolean;
 }
 import BaseModel from "../base/BaseModel";
 import LinkCollection from "../links/LinkCollection";

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

@@ -3,6 +3,14 @@ export default ConceptTypeDetailModel;
  * Model for concept details, available through modelcatalog
  */
 declare class ConceptTypeDetailModel extends ResourceModel {
+    /**
+     * The name of the concept type consists of the functional id of the kmt and the functional id of the concept type separated by a #.<br>
+     * For example BEI_CaseManagement#Case
+     */
+    get name(): string;
+    /**
+     */
+    get isCoreTaxonomy(): boolean;
     /**
      * Get concept type icon
      */
@@ -35,5 +43,16 @@ declare class ConceptTypeDetailModel extends ResourceModel {
      * Get sectionReferenceTypes
      */
     get sectionReferenceTypes(): Object[];
+    /**
+     */
+    get conceptTypeHierarchy(): LinkCollection;
+    /**
+     */
+    isOfConceptType(conceptTypeId: string): boolean;
+    /**
+     * Indicates if the given metamodel functional identifier exists in the hierarchy of concept types
+     */
+    hasMetamodelIdInHierarchy(metamodelId: string): boolean;
 }
 import ResourceModel from "../base/ResourceModel";
+import LinkCollection from "../links/LinkCollection";

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

@@ -19,6 +19,9 @@ export default class ContentIndexModel extends ResourceModel {
     /**
      */
     hasIndexFilter(): boolean;
+    /**
+     */
+    hasFiltersSet(): boolean;
     /**
      */
     hasNoFiltersSet(): boolean;

package/types/models/links/LinkCollection.d.ts

@@ -20,10 +20,18 @@ export default class LinkCollection extends BaseCollection<LinkModel> {
      * Get a link by it's key, handy for getting the self link
      */
     getLinkByKey(key: string): LinkModel | null;
+    /**
+     * Indicate if a link by key exists
+     */
+    hasLinkByKey(key: string): boolean;
     /**
      * Get a link by it's Href
      */
     getLinkByHref(href: Href | string): LinkModel | null;
+    /**
+     * Indicate if a link by href exists
+     */
+    hasLinkByHref(href: Href | string): boolean;
     /**
      * Getting the links by group key. For instance getting all 'tab' links of the web application.
      */

package/types/redux/_modularui/types.d.ts

@@ -39,6 +39,7 @@ type ModularUIAction = {
         childmodels?: boolean;
         targetModel?: any;
         forceTargetModel?: boolean;
+        cache?: boolean;
         successAction: (model: ModularUIModel) => SetModelAction | UpdateModelAction;
         errorAction?: ErrorAction;
     };