@beinformed/ui 1.55.2 → 1.57.0-contextpath.0

package/src/hooks/useModularUIModel.js

@@ -11,103 +11,150 @@ import UserProfileModel from "../models/user/UserProfileModel";
 
 import { useModularUIBasic } from "./useModularUIBasic";
 
+type HookOptions = {
+  origin?: string,
+  contextPath?: string,
+};
+
 /**
  * Load application
  */
-export const useApplication = (): ApplicationModel | null =>
+export const useApplication = (
+  options?: HookOptions,
+): ApplicationModel | null =>
   useModularUIBasic("application", "/", {
     expectedModels: ["Application"],
     targetModel: ApplicationModel,
+    ...options,
   });
 
 /**
  * Load a tab by href
  */
-export const useTab = (href: string): TabModel | null =>
+export const useTab = (href: string, options?: HookOptions): TabModel | null =>
   useModularUIBasic("tab", href, {
     expectedModels: ["Tab"],
     targetModel: TabModel,
+    ...options,
   });
 
 /**
  * Load caseview by href
  */
-export const useCaseView = (href: string): CaseViewModel | null =>
+export const useCaseView = (
+  href: string,
+  options?: HookOptions,
+): CaseViewModel | null =>
   useModularUIBasic("caseview", href, {
     expectedModels: ["CaseView"],
     targetModel: CaseViewModel,
+    ...options,
   });
 
 /**
  */
 export const usePanel = (
   href: string,
+  options?: HookOptions,
 ): ListModel | GroupingPanelModel | DetailModel | null =>
   useModularUIBasic("panel", href, {
     expectedModels: ["List", "GroupingPanel", "Detail"],
+    ...options,
   });
 
 /**
  */
-export const useList = (href: string): ListModel | null =>
+export const useList = (
+  href: string,
+  options?: HookOptions,
+): ListModel | null =>
   useModularUIBasic("list", href, {
     expectedModels: ["List"],
     targetModel: ListModel,
+    ...options,
   });
 
 /**
  */
-export const useListOrDetail = (href: string): ListModel | DetailModel | null =>
+export const useListOrDetail = (
+  href: string,
+  options?: HookOptions,
+): ListModel | DetailModel | null =>
   useModularUIBasic("list", href, {
     expectedModels: ["List", "Detail"],
     targetModel: [ListModel, DetailModel],
+    ...options,
   });
 
 /**
  */
-export const useListDetail = (href: string): ListDetailModel | null =>
+export const useListDetail = (
+  href: string,
+  options?: HookOptions,
+): ListDetailModel | null =>
   useModularUIBasic("listdetail", href, {
     expectedModels: ["ListDetail"],
     targetModel: ListDetailModel,
     forceTargetModel: true,
+    ...options,
   });
 
 /**
  */
-export const useGroupingPanel = (href: string): GroupingPanelModel | null =>
+export const useGroupingPanel = (
+  href: string,
+  options?: HookOptions,
+): GroupingPanelModel | null =>
   useModularUIBasic("groupingpanel", href, {
     expectedModels: ["GroupingPanel"],
     targetModel: GroupingPanelModel,
+    ...options,
   });
 
 /**
  */
-export const useDetailPanel = (href: string): DetailModel | null =>
+export const useDetailPanel = (
+  href: string,
+  options?: HookOptions,
+): DetailModel | null =>
   useModularUIBasic("detailpanel", href, {
     expectedModels: ["Detail"],
     targetModel: DetailModel,
+    ...options,
   });
 
 /**
  */
-export const useQuicksearch = (href: string): CaseSearchModel | null =>
+export const useQuicksearch = (
+  href: string,
+  options?: HookOptions,
+): CaseSearchModel | null =>
   useModularUIBasic("quicksearch", href, {
     expectedModels: ["CaseSearch"],
     targetModel: CaseSearchModel,
+    ...options,
   });
 
 /**
  */
-export const useSearch = (href: string): CaseSearchModel | null =>
+export const useSearch = (
+  href: string,
+  options?: HookOptions,
+): CaseSearchModel | null =>
   useModularUIBasic("search", href, {
     expectedModels: ["CaseSearch"],
     targetModel: CaseSearchModel,
+    ...options,
   });
 
 /**
  */
-export const useUserProfile = (href: string): UserProfileModel | null =>
+export const useUserProfile = (
+  href: string,
+  options?: HookOptions,
+): UserProfileModel | null =>
   useModularUIBasic("userprofile", href, {
     expectedModels: ["UserProfile"],
     targetModel: UserProfileModel,
+    ...options,
   });

package/src/models/actions/ActionCollection.js

@@ -6,7 +6,12 @@ import ActionModel from "./ActionModel";
  * Collection of actions
  */
 export default class ActionCollection extends BaseCollection<ActionModel> {
-  constructor(actions?: Object, actionsContributions?: Object) {
+  constructor(
+    actions?: Object,
+    actionsContributions?: Object,
+    origin?: string,
+    contextPath?: string,
+  ) {
     super();
 
     // no actions gives an empty collection
@@ -22,7 +27,14 @@ export default class ActionCollection extends BaseCollection<ActionModel> {
         );
 
         if (actionContribution) {
-          actionModels.push(new ActionModel(actionData, actionContribution));
+          actionModels.push(
+            new ActionModel(
+              actionData,
+              actionContribution,
+              origin,
+              contextPath,
+            ),
+          );
         }
       }
 

package/src/models/actions/ActionModel.js

@@ -6,12 +6,13 @@ import AttributeCollection from "../attributes/AttributeCollection";
 import BaseModel from "../base/BaseModel";
 import Href from "../href/Href";
 
-import { HTTP_METHODS } from "../../constants/Constants";
 import {
+  getBasePath,
+  HTTP_METHODS,
   CREATE_ACTION,
   UPDATE_ACTION,
   DELETE_ACTION,
-} from "../../constants/LayoutHints";
+} from "../../constants";
 
 import type { AttributeType } from "../types";
 
@@ -22,14 +23,23 @@ export default class ActionModel extends BaseModel {
   _fieldCollection: AttributeCollection;
   _href: Href;
   _icon: string;
-
-  constructor(data: Object, contributions: Object) {
+  _origin: ?string;
+  _contextPath: ?string;
+
+  constructor(
+    data: Object,
+    contributions: Object,
+    origin?: string,
+    contextPath?: string,
+  ) {
     super(data, contributions);
 
     this._fieldCollection = new AttributeCollection(
       this.data.fields,
       this.contributions.fields,
     );
+    this._origin = origin;
+    this._contextPath = contextPath;
   }
 
   /**
@@ -39,18 +49,12 @@ export default class ActionModel extends BaseModel {
     href: string,
     label: string,
     type: string = "form",
+    origin?: string,
+    contextPath?: string,
   ): ActionModel {
-    return new ActionModel(
-      {
-        name,
-        href,
-      },
-      {
-        name,
-        label: label || name,
-        type,
-      },
-    );
+    const data = { name, href };
+    const contributions = { name, label: label ?? name, type };
+    return new ActionModel(data, contributions, origin, contextPath);
   }
 
   /**
@@ -59,12 +63,30 @@ export default class ActionModel extends BaseModel {
     return this.data.href == null;
   }
 
+  /**
+   */
+  get origin(): string {
+    return this._origin ?? "";
+  }
+
+  /**
+   */
+  get contextPath(): string {
+    return this._contextPath ?? getBasePath();
+  }
+
   /**
    * retrieve href of action
    */
   get selfhref(): Href {
     return (
-      this._href || new Href(`${this.data.href}?${this.querystring}`, "Form")
+      this._href ??
+      new Href(
+        `${this.data.href}?${this.querystring}`,
+        "Form",
+        this.origin,
+        this.contextPath,
+      )
     );
   }
 

package/src/models/application/ApplicationModel.js

@@ -102,7 +102,13 @@ export default class ApplicationModel extends ResourceModel {
    * Get modelcatalog link
    */
   get modelcatalog(): LinkModel {
-    return LinkModel.create("modelcatalog", "/modelcatalog", "Model catalog");
+    return LinkModel.create(
+      "modelcatalog",
+      "/modelcatalog",
+      "Model catalog",
+      this.origin,
+      this.contextPath,
+    );
   }
 
   /**

package/src/models/base/ResourceModel.js

@@ -13,6 +13,7 @@ import type LinkModel from "../links/LinkModel";
 import type Href from "../href/Href";
 import type { ModularUIModel, IModelWithChildModels } from "../types";
 import type ErrorResponse from "../error/ErrorResponse";
+import { getBasePath } from "../../constants";
 
 /**
  * Base model, this the foundation for models that represent modular ui services, e.g. application, tab, caseview, etc
@@ -23,6 +24,8 @@ class ResourceModel extends BaseModel implements IModelWithChildModels {
   _childModels: Array<ModularUIModel>;
   _links: LinkCollection;
   _lastServerUpdate: number;
+  _origin: string = "";
+  _contextPath: string = getBasePath();
 
   /**
    * constructor
@@ -32,10 +35,12 @@ class ResourceModel extends BaseModel implements IModelWithChildModels {
 
     this._key = modularuiResponse.key;
     this._locale = modularuiResponse.locale;
-
     this._childModels = [];
 
     this._lastServerUpdate = Date.now();
+
+    this._origin = modularuiResponse.origin;
+    this._contextPath = modularuiResponse.contextPath;
   }
 
   /**
@@ -109,21 +114,39 @@ class ResourceModel extends BaseModel implements IModelWithChildModels {
     return this.getContribution("label", "");
   }
 
+  /**
+   */
+  get origin(): string {
+    return this._origin;
+  }
+
+  /**
+   */
+  get contextPath(): string {
+    return this._contextPath;
+  }
+
   /**
    * Getting the links of the resource
    */
   get links(): LinkCollection {
     if (!this._links) {
-      this._links = new LinkCollection(
-        Array.isArray(this.data._links)
-          ? this.data._links[0]
-          : this.data._links,
-        {
-          self: {
-            resourcetype: this.resourcetype,
-          },
-          ...this.contributions._links,
+      const linksData = Array.isArray(this.data._links)
+        ? this.data._links[0]
+        : this.data._links;
+
+      const linksContrubtions = {
+        self: {
+          resourcetype: this.resourcetype,
         },
+        ...this.contributions._links,
+      };
+
+      this._links = new LinkCollection(
+        linksData,
+        linksContrubtions,
+        this.origin,
+        this.contextPath,
       );
     }
     return this._links;
@@ -231,6 +254,8 @@ class ResourceModel extends BaseModel implements IModelWithChildModels {
       childModels: this._childModels.map<ModularUIModel>(
         (childModel: ModularUIModel) => childModel.dehydrate(),
       ),
+      origin: this._origin,
+      contextPath: this._contextPath,
     };
   }
 }

package/src/models/caseview/CaseViewModel.js

@@ -134,7 +134,7 @@ export default class CaseViewModel extends DetailModel {
       throw new IllegalStateException("No self href available");
     }
 
-    return new Href(selfLink.href);
+    return selfLink.href;
   }
 
   /**
@@ -160,6 +160,8 @@ export default class CaseViewModel extends DetailModel {
           taskgroup.name,
           taskgroup,
           taskgroupContributions,
+          this.origin,
+          this.contextPath,
         );
       });
   }

package/src/models/concepts/ConceptLinkModel.js

@@ -156,6 +156,7 @@ 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;
 

package/src/models/concepts/SourceReferenceModel.js

@@ -37,7 +37,8 @@ class SourceReferenceModel {
   /**
    */
   get selfhref(): Href {
-    return new Href(this._sourceReference._links.self.href);
+    // TODO SBO: origin and context
+    return new Href(this._sourceReference._links.self.href, "SourceReference");
   }
 
   /**

package/src/models/content/ContentIndexModel.js

@@ -73,7 +73,7 @@ export default class ContentIndexModel extends ResourceModel {
    * Getting the self link of this list
    */
   get selfhref(): Href {
-    const href = new Href(this.selflink.href);
+    const href = this.selflink.href;
 
     this.filterCollection.forEach((filter) => {
       filter.params.forEach((param) => {
@@ -150,6 +150,6 @@ export default class ContentIndexModel extends ResourceModel {
       )[0].code;
     }
 
-    return new Href(this.selfhref.path).addParameter("index", firstChar);
+    return new Href(this.selfhref).addParameter("index", firstChar);
   }
 }

package/src/models/content/ContentLinkModel.js

@@ -102,6 +102,7 @@ export default class ContentLinkModel
   /**
    */
   createEncodedHref(): Href {
+    // TODO SBO: origin and context
     const startURI = "/content/";
     const selfHref = new Href(this.data._links.self.href);
     const href = selfHref.path;
@@ -139,6 +140,7 @@ export default class ContentLinkModel
    */
   get links(): LinkCollection {
     if (!this._links) {
+      // TODO SBO: origin and context
       this._links = new LinkCollection(
         Array.isArray(this.data._links)
           ? this.data._links[0]

package/src/models/content/SectionModel.js

@@ -32,6 +32,7 @@ class SectionModel extends BaseModel {
    */
   get selflink(): LinkModel {
     if (!this._selflink) {
+      // TODO SBO: origin and context
       this._selflink = new LinkModel(this.data._links?.self);
     }
     return this._selflink;

package/src/models/detail/DetailModel.js

@@ -171,6 +171,8 @@ export default class DetailModel extends ResourceModel {
     this._actionCollection = new ActionCollection(
       this.data.actions,
       this.contributions.actions,
+      this.origin,
+      this.contextPath,
     );
   }
 

package/src/models/error/ErrorResponse.js

@@ -161,6 +161,7 @@ export default class ErrorResponse {
    *  Return response error redirect href
    */
   get redirectHref(): Href {
+    // TODO SBO: origin and context
     if (this.response.redirect?.href) {
       return new Href(this.response.redirect?.href);
     }
@@ -290,6 +291,7 @@ export default class ErrorResponse {
    * Get response url
    */
   get changePasswordHref(): ?Href {
+    // TODO SBO: origin and context
     return this.properties.redirect ? new Href(this.properties.redirect) : null;
   }
 

package/src/models/form/FormModel.js

@@ -605,7 +605,7 @@ class FormModel extends ResourceModel {
    */
   get successRedirect(): Href | null {
     return this.isFinished && this.success
-      ? new Href(this.success.redirect)
+      ? new Href(this.success.redirect, "", this.origin, this.contextPath)
       : null;
   }
 

package/src/models/href/Href.js

@@ -29,11 +29,18 @@ class Href {
   _method: $Keys<typeof HTTP_METHODS> = HTTP_METHODS.GET;
   _state: any = null;
   _referenceHash: ?number;
+  _origin: string = "";
+  _contextPath: string = getBasePath();
 
   /**
    * Create a Href
    */
-  constructor(href?: HrefInput, resourcetype?: string) {
+  constructor(
+    href?: HrefInput,
+    resourcetype?: string,
+    origin?: string,
+    contextPath?: string,
+  ) {
     this.resourcetype = resourcetype ?? "";
 
     if (href instanceof Href) {
@@ -43,12 +50,22 @@ class Href {
     } else if (typeof href === "object") {
       this.setFromLocationOrObject(href);
     }
+
+    if (typeof origin === "string") {
+      this.origin = origin;
+    }
+
+    if (typeof contextPath === "string") {
+      this.contextPath = contextPath;
+    }
   }
 
   /**
    * Set parameters from Href model input
    */
   setFromHref(href: Href) {
+    this.origin = href.origin;
+    this.contextPath = href.contextPath;
     this.path = href.path;
     this.parameters = href.parameters;
     this.hash = href.hash;
@@ -58,6 +75,15 @@ class Href {
   /**
    */
   setFromLocationOrObject(href: LocationShape | HrefObject) {
+    // $FlowFixMe
+    if (typeof href._origin === "string") {
+      this.origin = href._origin;
+    }
+    // $FlowFixMe
+    if (typeof href._contextPath === "string") {
+      this.contextPath = href._contextPath;
+    }
+
     if (typeof href["pathname"] === "string") {
       this.path = href.pathname;
     } else if (typeof href._path === "string") {
@@ -303,7 +329,36 @@ class Href {
    * Retrieve the path
    */
   get path(): string {
-    return this._path || "";
+    return this._path ?? "";
+  }
+
+  /**
+   * Retrieve the origin (e.g. http://example.com:18080)<br>
+   * Empty when the default must be used
+   */
+  get origin(): string {
+    return this._origin ?? "";
+  }
+
+  /**
+   * Set the origin (e.g. http://example.com:18080)
+   */
+  set origin(origin: string) {
+    this._origin = origin;
+  }
+
+  /**
+   * Get the context path
+   */
+  get contextPath(): string {
+    return this._contextPath;
+  }
+
+  /**
+   * Set the context path if different from default
+   */
+  set contextPath(contextPath: string) {
+    this._contextPath = contextPath;
   }
 
   /**
@@ -362,7 +417,7 @@ class Href {
       return this.path;
     }
 
-    return getBasePath() + this.path;
+    return this.origin + this.contextPath + this.path;
   }
 
   /**

package/src/models/href/ListHref.js

@@ -22,7 +22,7 @@ export default class ListHref extends Href {
    * Create a ListHref
    */
   constructor(href?: HrefInput, list?: ListModel, isPrefixed: boolean = true) {
-    super(href);
+    super(href, undefined);
 
     this._isPrefixed = isPrefixed;
 

package/src/models/links/LinkCollection.js

@@ -14,12 +14,18 @@ export default class LinkCollection extends BaseCollection<LinkModel> {
   /**
    * Constructs the link collection
    */
-  constructor(linkData: Object = {}, linkContributions: Object = {}) {
+  constructor(
+    linkData: Object = {},
+    linkContributions: Object = {},
+    origin?: string,
+    contextPath?: string,
+  ) {
     super();
 
     // There can be links in data and/or contributions (e.g. concept link is available through contributions)
     this.collection = normalizeLinkJSON(linkData, linkContributions).map(
-      ({ data, contributions }) => new LinkModel(data, contributions),
+      ({ data, contributions }) =>
+        new LinkModel(data, contributions, origin, contextPath),
     );
   }