@beinformed/ui 1.57.0-contextpath.1 → 1.57.0

package/src/models/concepts/ConceptIndexModel.js

@@ -32,7 +32,13 @@ export default class ConceptIndexModel extends ResourceModel {
     this._concepts = new ResourceCollection();
     this._concepts.collection = this.data._embedded
       ? this.data._embedded.results.map(
-          (concept) => new ConceptLinkModel(concept.concept, this.entryDate),
+          (concept) =>
+            new ConceptLinkModel(
+              concept.concept,
+              this.entryDate,
+              this.origin,
+              this.contextPath,
+            ),
         )
       : [];
   }

package/src/models/concepts/ConceptLinkModel.js

@@ -7,6 +7,7 @@ import { TIMEVERSION_FILTER_NAME } from "../../constants/Constants";
 
 import type { IModelWithChildModels, ModularUIModel } from "../types";
 import type Href from "../href/Href";
+import { getBasePath } from "../../constants";
 /**
  * Link to a concept
  */
@@ -17,14 +18,23 @@ export default class ConceptLinkModel
   _links: ?LinkCollection;
   _entryDate: ?ISO_DATE;
   _conceptType: ?ConceptTypeDetailModel;
+  _origin: string = "";
+  _contextPath: string = getBasePath();
 
   /**
    * Construct ConceptLinkModel
    */
-  constructor(data: Object, entryDate: ?ISO_DATE = null) {
+  constructor(
+    data: Object,
+    entryDate: ?ISO_DATE = null,
+    origin?: string,
+    contextPath?: string,
+  ) {
     super(data, {});
 
     this._entryDate = entryDate;
+    this._origin = origin || "";
+    this._contextPath = contextPath || getBasePath();
   }
 
   /**
@@ -97,6 +107,9 @@ export default class ConceptLinkModel
         Array.isArray(this.data._links)
           ? this.data._links[0]
           : this.data._links,
+        null,
+        this._contextPath,
+        this._origin,
       );
     }
 
@@ -156,7 +169,6 @@ export default class ConceptLinkModel
   /**
    */
   asLinkModel(): LinkModel {
-    // TODO SBO: origin and contextpath
     const link = LinkModel.create(this.key, this.selfhref.href, this.label);
     link.href = this.selfhref;
 
@@ -169,11 +181,4 @@ export default class ConceptLinkModel
   isOfConceptType(conceptTypeId: string): boolean {
     return this.conceptType?.isOfConceptType(conceptTypeId) ?? false;
   }
-
-  /**
-   * Indicates if the given metamodel functional identifier exists in the hierarchy of concept types for this concept
-   */
-  hasMetamodelIdInConceptTypeHierarchy(metamodelId: string): boolean {
-    return this.conceptType?.hasMetamodelIdInHierarchy(metamodelId) ?? false;
-  }
 }

package/src/models/concepts/ConceptTypeDetailModel.js

@@ -2,7 +2,6 @@
 import ResourceModel from "../base/ResourceModel";
 
 import type ModularUIResponse from "../../modularui/ModularUIResponse";
-import type LinkCollection from "../links/LinkCollection";
 
 /**
  * Model for concept details, available through modelcatalog
@@ -12,8 +11,8 @@ 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 {
-    return this.getData("name", "");
+  get kmtId(): string {
+    return this.getData("kmtId", "");
   }
 
   /**
@@ -119,31 +118,10 @@ class ConceptTypeDetailModel extends ResourceModel {
     return this.getData("sectionReferenceTypes", []);
   }
 
-  /**
-   */
-  get conceptTypeHierarchy(): LinkCollection {
-    return this.links.getLinksByGroup("conceptTypeHierarchy");
-  }
-
   /**
    */
   isOfConceptType(conceptTypeId: string): boolean {
-    return (
-      this.conceptTypeHierarchy?.hasLinkByKey(conceptTypeId) ||
-      this.conceptTypeHierarchy?.hasLinkByHref(conceptTypeId) ||
-      this.selfhref.equals(conceptTypeId)
-    );
-  }
-
-  /**
-   * Indicates if the given metamodel functional identifier exists in the hierarchy of concept types
-   */
-  hasMetamodelIdInHierarchy(metamodelId: string): boolean {
-    return (
-      this.conceptTypeHierarchy?.all.some((link) =>
-        link.key.startsWith(metamodelId + "#"),
-      ) || false
-    );
+    return this.selfhref.equals(conceptTypeId);
   }
 }
 

package/src/models/concepts/SourceReferenceCollection.js

@@ -11,13 +11,20 @@ export default class SourceReferenceCollection extends BaseCollection<SourceRefe
   constructor(
     sourceReferences: Array<Object> = [],
     entryDate: ?ISO_DATE = null,
+    origin?: string,
+    contextPath?: string,
   ) {
     super();
 
     this.collection = sourceReferences
       ? sourceReferences.map(
           (sourceReference) =>
-            new SourceReferenceModel(sourceReference, entryDate),
+            new SourceReferenceModel(
+              sourceReference,
+              entryDate,
+              origin,
+              contextPath,
+            ),
         )
       : [];
   }

package/src/models/concepts/SourceReferenceModel.js

@@ -3,18 +3,28 @@ import { createHashFromHref } from "../../utils/helpers/createHash";
 
 import ContentLinkModel from "../content/ContentLinkModel";
 import Href from "../href/Href";
+import { getBasePath } from "../../constants";
 
 /**
  */
 class SourceReferenceModel {
   _sourceReference: Object;
   _entryDate: ?ISO_DATE;
+  _origin: string = "";
+  _contextPath: string = getBasePath();
 
   /**
    */
-  constructor(sourceReference: Object, entryDate: ?ISO_DATE = null) {
+  constructor(
+    sourceReference: Object,
+    entryDate: ?ISO_DATE = null,
+    origin?: string,
+    contextPath?: string,
+  ) {
     this._sourceReference = sourceReference;
     this._entryDate = entryDate;
+    this._origin = origin || "";
+    this._contextPath = contextPath || getBasePath();
   }
 
   /**
@@ -31,14 +41,20 @@ class SourceReferenceModel {
         section,
       },
       this._entryDate,
+      this._origin,
+      this._contextPath,
     );
   }
 
   /**
    */
   get selfhref(): Href {
-    // TODO SBO: origin and context
-    return new Href(this._sourceReference._links.self.href, "SourceReference");
+    return new Href(
+      this._sourceReference._links.self.href,
+      "SourceReference",
+      this._origin,
+      this._contextPath,
+    );
   }
 
   /**

package/src/models/concepts/__mock__/conceptindex.js

@@ -0,0 +1,15 @@
+import ConceptIndexModel from "../ConceptIndexModel";
+import ModularUIResponse from "../../../modularui/ModularUIResponse";
+
+import data from "./conceptindex_data.json";
+import contributions from "./conceptindex_contributions.json";
+
+const conceptIndexResponse = ModularUIResponse.create({
+  key: "ConceptSearch",
+  data,
+  contributions,
+});
+
+const conceptIndex = new ConceptIndexModel(conceptIndexResponse);
+
+export { conceptIndex };

package/src/models/concepts/__mock__/conceptindex_contributions.json

@@ -0,0 +1,86 @@
+{
+  "ConceptSearch": {
+    "label": "Concept search",
+    "resourcetype": "ConceptSearch",
+    "filter": [
+      {
+        "index": {
+          "type": "choicefilter",
+          "label": "Index",
+          "layouthint": ["combobox"],
+          "multiplechoice": false,
+          "optionMode": "dynamic"
+        }
+      },
+      {
+        "label": {
+          "type": "stringfilter",
+          "label": "Label",
+          "multiplechoice": false
+        }
+      },
+      {
+        "type": {
+          "type": "choicefilter",
+          "label": "Type",
+          "layouthint": ["checkbox"],
+          "multiplechoice": true,
+          "optionMode": "lookup"
+        }
+      },
+      {
+        "modelCategory": {
+          "type": "choicefilter",
+          "label": "Model category",
+          "layouthint": ["checkbox"],
+          "multiplechoice": true,
+          "optionMode": "static",
+          "options": [
+            {
+              "key": "BusinessDesign",
+              "label": "Business design"
+            },
+            {
+              "key": "FLINT",
+              "label": "FLINT"
+            },
+            {
+              "key": "Requirements",
+              "label": "Requirements"
+            },
+            {
+              "key": "Scenarios",
+              "label": "Scenarios"
+            }
+          ]
+        }
+      },
+      {
+        "entryDate": {
+          "type": "datefilter",
+          "label": "Entry date",
+          "format": "dd-MM-yyyy",
+          "formatlabel": "dd-mm-yyyy",
+          "operator": "greater-than-or-equal"
+        }
+      }
+    ],
+    "results": {
+      "concept": {
+        "metadata": {
+          "_id": {
+            "type": "string"
+          }
+        },
+        "attributes": [
+          {
+            "label": {
+              "type": "string",
+              "label": "concept label"
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/src/models/concepts/__mock__/conceptindex_data.json

@@ -0,0 +1,323 @@
+{
+  "concepts": {
+    "_links": {
+      "self": {
+        "href": "/concepts"
+      },
+      "api_doc": {
+        "href": "/api-docs/v3/concepts"
+      },
+      "contributions": {
+        "href": "/contributions/concepts"
+      }
+    },
+    "dynamicschema": {
+      "index": [
+        {
+          "code": "0",
+          "label": "0-9"
+        },
+        {
+          "code": "A",
+          "label": "A"
+        },
+        {
+          "code": "B",
+          "label": "B"
+        },
+        {
+          "code": "C",
+          "label": "C"
+        },
+        {
+          "code": "D",
+          "label": "D"
+        },
+        {
+          "code": "E",
+          "label": "E"
+        },
+        {
+          "code": "F",
+          "label": "F"
+        },
+        {
+          "code": "G",
+          "label": "G"
+        },
+        {
+          "code": "H",
+          "label": "H"
+        },
+        {
+          "code": "I",
+          "label": "I"
+        },
+        {
+          "code": "J",
+          "label": "J"
+        },
+        {
+          "code": "K",
+          "label": "K"
+        },
+        {
+          "code": "L",
+          "label": "L"
+        },
+        {
+          "code": "M",
+          "label": "M"
+        },
+        {
+          "code": "N",
+          "label": "N"
+        },
+        {
+          "code": "O",
+          "label": "O"
+        },
+        {
+          "code": "P",
+          "label": "P"
+        },
+        {
+          "code": "Q",
+          "label": "Q"
+        },
+        {
+          "code": "R",
+          "label": "R"
+        },
+        {
+          "code": "S",
+          "label": "S"
+        },
+        {
+          "code": "T",
+          "label": "T"
+        },
+        {
+          "code": "U",
+          "label": "U"
+        },
+        {
+          "code": "V",
+          "label": "V"
+        },
+        {
+          "code": "W",
+          "label": "W"
+        }
+      ],
+      "type": null
+    },
+    "filter": {
+      "index": {
+        "param": "index",
+        "name": "index",
+        "options": [
+          {
+            "key": "0"
+          },
+          {
+            "key": "A"
+          },
+          {
+            "key": "B"
+          },
+          {
+            "key": "C"
+          },
+          {
+            "key": "D"
+          },
+          {
+            "key": "E"
+          },
+          {
+            "key": "F"
+          },
+          {
+            "key": "G"
+          },
+          {
+            "key": "H"
+          },
+          {
+            "key": "I"
+          },
+          {
+            "key": "J"
+          },
+          {
+            "key": "K"
+          },
+          {
+            "key": "L"
+          },
+          {
+            "key": "M"
+          },
+          {
+            "key": "N"
+          },
+          {
+            "key": "O"
+          },
+          {
+            "key": "P"
+          },
+          {
+            "key": "Q"
+          },
+          {
+            "key": "R"
+          },
+          {
+            "key": "S"
+          },
+          {
+            "key": "T"
+          },
+          {
+            "key": "U"
+          },
+          {
+            "key": "V"
+          },
+          {
+            "key": "W"
+          }
+        ]
+      },
+      "label": {
+        "param": "label",
+        "name": "label"
+      },
+      "type": {
+        "param": "type",
+        "name": "type",
+        "_links": {
+          "lookupOptions": {
+            "href": "/lookupOptions?lookupToken=4bcc52d9-3f60-4f8a-b745-0814b7aca09f",
+            "filter": {
+              "name": "labelFilter"
+            }
+          }
+        }
+      },
+      "entryDate": {
+        "param": "entryDate",
+        "name": "entryDate",
+        "value": "2024-10-21"
+      },
+      "modelCategory": {
+        "param": "modelCategory",
+        "name": "modelCategory"
+      }
+    },
+    "_embedded": {
+      "results": [
+        {
+          "concept": {
+            "_id": "CaptureComplianceArtifactsInCustomerCase",
+            "label": "Capture compliance artifacts in customer case",
+            "_links": {
+              "self": {
+                "href": "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/CaptureComplianceArtifactsInCustomerCase"
+              },
+              "concepttype": {
+                "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement"
+              }
+            }
+          }
+        },
+        {
+          "concept": {
+            "_id": "ConformApplicationPatterns",
+            "label": "Conform application patterns",
+            "_links": {
+              "self": {
+                "href": "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/ConformApplicationPatterns"
+              },
+              "concepttype": {
+                "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement"
+              }
+            }
+          }
+        },
+        {
+          "concept": {
+            "_id": "ConformDesignPatterns",
+            "label": "Conform design patterns",
+            "_links": {
+              "self": {
+                "href": "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/ConformDesignPatterns"
+              },
+              "concepttype": {
+                "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement"
+              }
+            }
+          }
+        },
+        {
+          "concept": {
+            "_id": "DesignShouldSupportTheCompleteProcess",
+            "label": "Design should support the complete process",
+            "_links": {
+              "self": {
+                "href": "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/DesignShouldSupportTheCompleteProcess"
+              },
+              "concepttype": {
+                "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement"
+              }
+            }
+          }
+        },
+        {
+          "concept": {
+            "_id": "MaintainACustomerProfile",
+            "label": "Maintain a customer profile",
+            "_links": {
+              "self": {
+                "href": "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/MaintainACustomerProfile"
+              },
+              "concepttype": {
+                "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement"
+              }
+            }
+          }
+        },
+        {
+          "concept": {
+            "_id": "RepositoryReflectsOwnershipResponsiblityAndLifecycleParameters",
+            "label": "Repository reflects ownership, responsiblity and lifecycle parameters",
+            "_links": {
+              "self": {
+                "href": "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/RepositoryReflectsOwnershipResponsiblityAndLifecycleParameters"
+              },
+              "concepttype": {
+                "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement"
+              }
+            }
+          }
+        },
+        {
+          "concept": {
+            "_id": "SeparateFrontAndBackOfficeProcesses",
+            "label": "Separate front and back office processes",
+            "_links": {
+              "self": {
+                "href": "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/SeparateFrontAndBackOfficeProcesses"
+              },
+              "concepttype": {
+                "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement"
+              }
+            }
+          }
+        }
+      ]
+    }
+  }
+}

package/src/models/concepts/__mock__/concepttype_hierarchy.json

@@ -9,17 +9,7 @@
       },
       "contributions": {
         "href": "/contributions/concepttypes/(knowledge-model-type-identifier)/(concept-type-identifier)"
-      },
-      "conceptTypeHierarchy": [
-        {
-          "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/Advice%20and%20request%20business%20scenarios.bixml/ScenarioStep_Advice",
-          "name": "Adviceandrequestbusinessscenarios#ScenarioStep_Advice"
-        },
-        {
-          "href": "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/Business%20scenarios.bixml/ScenarioStep",
-          "name": "BusinessScenarios#ScenarioStep"
-        }
-      ]
+      }
     },
     "_id": "ScenarioStep_Advice",
     "label": "Advice scenario step",

package/src/models/concepts/__tests__/ConceptIndexModel.spec.js

@@ -1,10 +1,38 @@
 import ConceptIndexModel from "../ConceptIndexModel";
 
+import { conceptIndex } from "../__mock__/conceptindex";
+
 describe("conceptIndexModel", () => {
   it("should be able to create an empty ConceptIndexModel object", () => {
-    const conceptIndex = new ConceptIndexModel();
+    const emptyConceptIndex = new ConceptIndexModel();
+
+    expect(emptyConceptIndex).toBeInstanceOf(ConceptIndexModel);
+    expect(emptyConceptIndex.type).toBe("ConceptIndex");
+  });
 
+  it("should be able to create a ConceptIndexModel from concept search resposne", () => {
     expect(conceptIndex).toBeInstanceOf(ConceptIndexModel);
-    expect(conceptIndex.type).toBe("ConceptIndex");
+
+    expect(conceptIndex.label).toBe("Concept search");
+    expect(conceptIndex.selfhref.toString()).toBe(
+      "/concepts?entryDate=2024-10-21",
+    );
+
+    expect(conceptIndex.indexfilter.label).toBe("Index");
+    expect(conceptIndex.searchtermfilter.label).toBe("Label");
+    expect(conceptIndex.modelCategoryFilter.label).toBe("Model category");
+
+    expect(conceptIndex.items.size).toBe(7);
+
+    const firstItem = conceptIndex.items.first;
+    expect(firstItem.label).toBe(
+      "Capture compliance artifacts in customer case",
+    );
+    expect(firstItem.selfhref.toString()).toBe(
+      "/concepts/bundle-com.beinformed.models.FSDemoBusinessDesign/High%20level%20requirements/Architectural%20significant%20requirements.beimodel.json/CaptureComplianceArtifactsInCustomerCase?entryDate=2024-10-21",
+    );
+    expect(firstItem.conceptTypeLink.href.toString()).toBe(
+      "/concepttypes/bundle-com.beinformed.fs.demo.metamodels/High%20level%20requirements.bixml/ArchitecturalSignificantRequirement",
+    );
   });
 });