@beinformed/ui 1.42.1 → 1.42.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beinformed/ui",
-  "version": "1.42.1",
+  "version": "1.42.2",
   "description": "Toolbox for be informed javascript layouts",
   "license": "SEE LICENSE IN LICENSE.md",
   "bugs": "http://support.beinformed.com",

package/src/hooks/useModelCatalog.js

@@ -1,6 +1,8 @@
 // @flow
 import { useLocation } from "./useRouter";
 
+import { createHref, filterParameters } from "../utils/helpers/createHref";
+
 import ModelCatalogModel from "../models/modelcatalog/ModelCatalogModel";
 import ConceptIndexModel from "../models/concepts/ConceptIndexModel";
 import ConceptDetailModel from "../models/concepts/ConceptDetailModel";
@@ -11,7 +13,6 @@ import ContentModel from "../models/content/ContentModel";
 
 import { useModularUIBasic } from "./useModularUIBasic";
 import { ContentTypeModel } from "../models";
-import type { Location } from "react-router";
 
 /**
  */
@@ -23,25 +24,12 @@ export const useModelCatalog = (): ?ModelCatalogModel =>
 
 /**
  */
-export const useConceptIndex = (href: string): ?ConceptIndexModel =>
-  useModularUIBasic("conceptindex", href, {
+export const useConceptIndex = (href: string): ?ConceptIndexModel => {
+  const url = filterParameters(href, ["entryDate", "index", "label", "type"]);
+  return useModularUIBasic("conceptindex", url, {
     expectedModels: ["ConceptIndex"],
     targetModel: ConceptIndexModel,
   });
-
-const getHref = (context: string, dynamic: string, location?: Location) => {
-  let href = dynamic;
-  if (!href.startsWith(`/${context}/`)) {
-    href = `/${context}/${href}`;
-  }
-
-  href = href.replace(/\/\//g, "/");
-
-  if (location?.search) {
-    href = `${href}${location.search}`;
-  }
-
-  return href;
 };
 
 /**
@@ -51,7 +39,7 @@ export const useConceptDetail = (
 ): ?ConceptDetailModel | ?BusinessScenarioModel => {
   const location = useLocation();
 
-  const href = getHref("concepts", concept, location);
+  const href = createHref("concepts", concept, location, ["entryDate"]);
   return useModularUIBasic("conceptdetail", href, {
     expectedModels: ["ConceptDetail", "BusinessScenario"],
   });
@@ -59,17 +47,19 @@ export const useConceptDetail = (
 
 /**
  */
-export const useContentIndex = (href: string): ?ContentIndexModel =>
-  useModularUIBasic("contentindex", href, {
+export const useContentIndex = (href: string): ?ContentIndexModel => {
+  const url = filterParameters(href, ["index", "label", "type"]);
+  return useModularUIBasic("contentindex", url, {
     expectedModels: ["ContentIndex"],
     targetModel: ContentIndexModel,
   });
+};
 
 /**
  */
 export const useContentTOC = (content: string): ?ContentTOCModel => {
   const location = useLocation();
-  const href = getHref("content", content, location);
+  const href = createHref("content", content, location, ["entryDate"]);
   return useModularUIBasic("contenttoc", href, {
     expectedModels: ["ContentTOC"],
     targetModel: ContentTOCModel,
@@ -79,7 +69,7 @@ export const useContentTOC = (content: string): ?ContentTOCModel => {
 /**
  */
 export const useContent = (contentSection: string): ?ContentModel => {
-  const href = getHref("content", contentSection);
+  const href = createHref("content", contentSection, null, ["entryDate"]);
   return useModularUIBasic("content", href, {
     expectedModels: ["Content"],
     targetModel: ContentModel,
@@ -89,7 +79,7 @@ export const useContent = (contentSection: string): ?ContentModel => {
 /**
  */
 export const useContentType = (contentType: string): ?ContentTypeModel => {
-  const href = getHref("contenttypes", contentType);
+  const href = createHref("contenttypes", contentType, null, ["entryDate"]);
   return useModularUIBasic("contenttypes", href, {
     expectedModels: ["ContentType"],
     targetModel: ContentTypeModel,

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

@@ -0,0 +1,30 @@
+import { createHref } from "../createHref";
+
+describe("createHref", () => {
+  it("can filter out qs parameters", () => {
+    const dynamicPart = "project/folder/model.bixml/ConceptId";
+    const location = {
+      search: "?entryDate=2024-03-08&index=C&notAllowed=true",
+    };
+
+    expect(createHref("concepts", dynamicPart)).toBe(
+      "/concepts/" + dynamicPart,
+    );
+    expect(createHref("concepts", dynamicPart, location)).toBe(
+      "/concepts/" + dynamicPart + location.search,
+    );
+    expect(
+      createHref("concepts", dynamicPart, location, ["entryDate", "index"]),
+    ).toBe("/concepts/" + dynamicPart + "?entryDate=2024-03-08&index=C");
+    expect(
+      createHref("concepts", dynamicPart + location.search, location, [
+        "entryDate",
+        "index",
+      ]),
+    ).toBe("/concepts/" + dynamicPart + "?entryDate=2024-03-08&index=C");
+
+    expect(createHref("concepts", dynamicPart + "#hash")).toBe(
+      "/concepts/" + dynamicPart + "#hash",
+    );
+  });
+});

package/src/utils/helpers/createHref.js

@@ -0,0 +1,80 @@
+// @flow
+import type { Location } from "react-router";
+
+/**
+ */
+export const parseUrl = (
+  href: string,
+): { path: string, querystring: null | string, hash: null | string } => {
+  let path = href;
+  let hash = null;
+  let querystring = null;
+  if (href.includes("#")) {
+    const hashSplit = href.split("#");
+    path = hashSplit[0];
+    hash = hashSplit[1];
+  }
+  if (href.includes("?")) {
+    const qsSplit = path.split("?");
+    path = qsSplit[0];
+    querystring = qsSplit[1];
+  }
+  return {
+    path,
+    querystring,
+    hash,
+  };
+};
+
+/**
+ */
+export const filterParameters = (
+  href: string,
+  allowedParameters?: Array<string>,
+): string => {
+  if (!Array.isArray(allowedParameters)) {
+    return href;
+  }
+
+  const url = parseUrl(href);
+  let filteredUrl = url.path;
+  if (url.querystring) {
+    const searchParams = new URLSearchParams(url.querystring);
+    const params = Array.from(searchParams.keys());
+    for (const param of params) {
+      if (!allowedParameters.includes(param)) {
+        searchParams.delete(param);
+      }
+    }
+    filteredUrl = filteredUrl + "?" + searchParams.toString();
+  }
+  if (url.hash) {
+    filteredUrl = filteredUrl + "#" + url.hash;
+  }
+  return filteredUrl;
+};
+
+/**
+ */
+export const createHref = (
+  context: string,
+  dynamicPart: string,
+  location?: ?Location,
+  allowedParameters?: Array<string>,
+): string => {
+  let href = dynamicPart;
+  if (!href.startsWith(`/${context}/`)) {
+    href = `/${context}/${href}`;
+  }
+
+  href = href.replace(/\/\//g, "/");
+
+  if (location?.search && !href.includes("?")) {
+    const search = location.search.startsWith("?")
+      ? location.search.substring(1)
+      : location.search;
+    href = `${href}?${search}`;
+  }
+
+  return filterParameters(href, allowedParameters);
+};

package/src/utils/helpers/index.js

@@ -6,3 +6,4 @@ export * from "./objects";
 export * from "./text";
 export * from "./checkResource";
 export * from "./repositoryResource";
+export * from "./createHref";