@beinformed/ui 1.25.2 → 1.25.5

package/src/hooks/useModularUIRequest.js

@@ -5,21 +5,22 @@ import { useSelector } from "react-redux";
 import ModularUIRequest from "../modularui/ModularUIRequest";
 import { getLocale } from "../redux/selectors/i18n";
 
-import type { RequestBaseOptions } from "../utils";
 import type Href from "../models/href/Href";
-
-const getModularUIRequest = createSelector([getLocale], (localeCode) => {
-  return (href: Href, options?: $Shape<RequestBaseOptions>) => {
-    const request = new ModularUIRequest(href, options);
-    request.locale = localeCode;
-    return request;
-  };
-});
+import type { RequestModularUIOptions } from "../utils";
 
 /**
  * Creates a ModularUIRequest with the locale as available in the redux store
  */
 export const useModularUIRequest = (): ((
   href: Href,
-  options?: $Shape<RequestBaseOptions>
-) => ModularUIRequest) => useSelector(getModularUIRequest);
+  options?: $Shape<RequestModularUIOptions>
+) => ModularUIRequest) =>
+  useSelector(
+    createSelector([getLocale], (localeCode) => {
+      return (href: Href, options?: $Shape<RequestModularUIOptions>) => {
+        const request = new ModularUIRequest(href, options);
+        request.locale = localeCode;
+        return request;
+      };
+    })
+  );

package/src/models/application/ApplicationModel.js

@@ -9,6 +9,7 @@ import type { ModularUIModel, AuthenticationType } from "../types";
 import type { ModularUIResponse } from "../../modularui";
 import type LinkCollection from "../links/LinkCollection";
 import type Href from "../href/Href";
+import { fallbackDefaultAuthenticationType } from "../../constants";
 
 /**
  * The Application model
@@ -23,6 +24,12 @@ export default class ApplicationModel extends ResourceModel {
     return "Application";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ApplicationModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {
@@ -68,7 +75,9 @@ export default class ApplicationModel extends ResourceModel {
    * Getting the authentication types of the application
    */
   get authenticationTypes(): Array<AuthenticationType> {
-    const authenticationTypes = this.getContribution("security", []);
+    const authenticationTypes = this.getContribution("security", [
+      fallbackDefaultAuthenticationType,
+    ]);
 
     //put primary first
     return authenticationTypes?.sort(

package/src/models/base/ResourceModel.js

@@ -37,6 +37,13 @@ class ResourceModel extends BaseModel implements IModelWithChildModels {
     this._lastServerUpdate = Date.now();
   }
 
+  /**
+   * Property to render name of a model, is original name after transpilation
+   */
+  static get modelName(): string {
+    throw new IllegalStateException(`No modelName set on the resource model`);
+  }
+
   /**
    * Returns true when the model is supported based on configuration found in contributions
    *

package/src/models/caseview/CaseViewModel.js

@@ -33,6 +33,12 @@ export default class CaseViewModel extends DetailModel {
     return "CaseView";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "CaseViewModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/concepts/BusinessScenarioModel.js

@@ -19,6 +19,12 @@ class BusinessScenarioModel extends ConceptDetailModel {
     return "BusinessScenario";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "BusinessScenario";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/concepts/ConceptDetailModel.js

@@ -41,6 +41,12 @@ export default class ConceptDetailModel extends ResourceModel {
     return "ConceptDetail";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ConceptDetailModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/concepts/ConceptIndexModel.js

@@ -46,6 +46,12 @@ export default class ConceptIndexModel extends ResourceModel {
     return "ConceptIndex";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ConceptIndexModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/concepts/ConceptTypeDetailModel.js

@@ -13,6 +13,12 @@ class ConceptTypeDetailModel extends ResourceModel {
     return "ConceptTypeDetail";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ConceptTypeDetailModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/content/ContentIndexModel.js

@@ -41,6 +41,12 @@ export default class ContentIndexModel extends ResourceModel {
     return "ContentIndex";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ContentIndexModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/content/ContentModel.js

@@ -35,6 +35,12 @@ export default class ContentModel extends ResourceModel {
     return "Content";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ContentModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/content/ContentTOCModel.js

@@ -49,6 +49,12 @@ export default class ContentTOCModel extends ResourceModel {
     return "ContentTOC";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ContentTOCModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/content/ContentTypeModel.js

@@ -12,6 +12,12 @@ export default class ContentTypeModel extends ResourceModel {
     return "ContentType";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ContentTypeModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/detail/DetailModel.js

@@ -37,6 +37,12 @@ export default class DetailModel extends ResourceModel {
     return "Detail";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "DetailModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/form/FormModel.js

@@ -95,6 +95,12 @@ class FormModel extends ResourceModel {
     return this.getContribution("actiontype", "form");
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "FormModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/list/ListDetailModel.js

@@ -83,6 +83,12 @@ export default class ListDetailModel extends DetailModel {
     return "ListDetail";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ListDetailModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/list/ListModel.js

@@ -41,6 +41,12 @@ export default class ListModel extends ResourceModel {
     return "List";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ListModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/lookup/LookupOptionsModel.js

@@ -33,6 +33,12 @@ export default class LookupOptionsModel extends ResourceModel {
     return "LookupOptions";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "LookupOptionsModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/modelcatalog/ModelCatalogModel.js

@@ -14,6 +14,12 @@ export default class ModelCatalogModel extends ResourceModel {
     return "ModelCatalog";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "ModelCatalogModel";
+  }
+
   /**
    */
   static isApplicableModel(data: Object): boolean {

package/src/models/panels/GroupingPanelModel.js

@@ -30,6 +30,12 @@ export default class GroupingPanelModel extends ResourceModel {
     return "GroupingPanel";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "GroupingPanelModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/resolveModel.js

@@ -25,9 +25,10 @@ import ContentModel from "./content/ContentModel";
 import ContentTypeModel from "./content/ContentTypeModel";
 import LookupOptionsModel from "./lookup/LookupOptionsModel";
 
+import { IllegalArgumentException } from "../exceptions";
+
 import type ModularUIResponse from "../modularui/ModularUIResponse";
 import type { ModularUIModel } from "./types";
-import { IllegalArgumentException } from "../exceptions";
 
 /**
  * Mapping of models and resourcetypes
@@ -62,7 +63,8 @@ const RESOURCE_MODELS = [
  * Resolve a model by resource
  */
 const resolveModel = (
-  data: ModularUIResponse
+  data: ModularUIResponse,
+  availableModels: Array<Class<ModularUIModel>> = RESOURCE_MODELS
 ): Class<ModularUIModel> | null => {
   if (!data) {
     throw new IllegalArgumentException(
@@ -72,11 +74,11 @@ const resolveModel = (
 
   if (!has(data.contributions, "resourcetype")) {
     throw new IllegalArgumentException(
-      "Data has wrong format, missing resourcetype in contributions, cannot resolve model"
+      "Data has wrong format, missing resourcetype property in contributions, cannot resolve model"
     );
   }
 
-  const resourceTypeModel = RESOURCE_MODELS.find((resourceModel) =>
+  const resourceTypeModel = availableModels.find((resourceModel) =>
     resourceModel.isApplicableModel(data)
   );
 

package/src/models/search/CaseSearchModel.js

@@ -14,6 +14,12 @@ export default class CaseSearchModel extends ListModel {
     return "CaseSearch";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "CaseSearchModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/tab/TabModel.js

@@ -35,6 +35,12 @@ export default class TabModel extends ResourceModel {
     return "Tab";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "TabModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/taskgroup/TaskGroupModel.js

@@ -51,6 +51,12 @@ export default class TaskGroupModel extends ResourceModel {
     return "TaskGroup";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "TaskGroupModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/types.js

@@ -157,7 +157,7 @@ export interface IModelWithChildModels {
 export type AuthenticationType = {
   name: string,
   authentication: string,
-  redirectUri: string,
+  redirectUri?: string,
   isPrimary: boolean,
 };
 

package/src/models/user/UserModel.js

@@ -13,6 +13,12 @@ export default class UserModel extends ResourceModel {
     return "User";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "UserModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/models/user/UserProfileModel.js

@@ -44,4 +44,10 @@ export default class UserProfileModel extends UserModel {
   get attributeCollection(): AttributeCollection {
     return this._attributeCollection;
   }
+
+  /**
+   */
+  static get modelName(): string {
+    return "UserProfileModel";
+  }
 }

package/src/models/user/UserServicesModel.js

@@ -19,6 +19,12 @@ class UserServicesModel extends ResourceModel {
     return "UserServices";
   }
 
+  /**
+   */
+  static get modelName(): string {
+    return "UserServicesModel";
+  }
+
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {

package/src/modularui/ModularUIRequest.js

@@ -25,7 +25,11 @@ import { IllegalArgumentException, IllegalStateException } from "../exceptions";
 
 import { isPlainObject } from "../utils/helpers/objects";
 
-import type { RequestBaseOptions } from "../utils/fetch/types";
+import type { TargetModel } from "./types";
+import type {
+  RequestBaseOptions,
+  RequestModularUIOptions,
+} from "../utils/fetch/types";
 import type { ModularUIModel } from "../models/types";
 
 /**
@@ -36,8 +40,9 @@ class ModularUIRequest {
   _response: ModularUIResponse;
 
   _href: Href;
-  _options: RequestBaseOptions;
-  _targetModel: ?Class<ModularUIModel>;
+  _options: RequestModularUIOptions;
+  _targetModel: ?TargetModel;
+  _forceTargetModel: boolean = false;
   _contributionsHref: string;
   _locale: string;
   _method: $Keys<typeof HTTP_METHODS> = HTTP_METHODS.GET;
@@ -46,7 +51,10 @@ class ModularUIRequest {
 
   /**
    */
-  constructor(href: Href | string, options: $Shape<RequestBaseOptions> = {}) {
+  constructor(
+    href: Href | string,
+    options: $Shape<RequestModularUIOptions> = {}
+  ) {
     if (!href) {
       throw new IllegalArgumentException(
         "You must pass a href to the resource that is requested"
@@ -132,7 +140,7 @@ class ModularUIRequest {
 
   /**
    */
-  get options(): RequestBaseOptions {
+  get options(): RequestModularUIOptions {
     return {
       ...this._options,
       locale: this.locale,
@@ -142,7 +150,24 @@ class ModularUIRequest {
 
   /**
    */
-  set options(options: RequestBaseOptions) {
+  get requestOptions(): RequestBaseOptions {
+    /* eslint-disable no-unused-vars */
+    const {
+      targetModel,
+      forceTargetModel,
+      updateModel,
+      childmodels,
+      isValidationRequest,
+      removeOnUnmount,
+      ...requestOptions
+    } = this.options;
+    /* eslint-enable no-unused-vars */
+    return requestOptions;
+  }
+
+  /**
+   */
+  set options(options: RequestModularUIOptions) {
     this._options = options;
   }
 
@@ -156,31 +181,73 @@ class ModularUIRequest {
 
   /**
    */
-  set targetModel(targetModel: ?Class<ModularUIModel>) {
+  set targetModel(targetModel: TargetModel) {
     this._targetModel = targetModel;
   }
 
   /**
    */
-  get targetModel(): ?Class<ModularUIModel> {
+  get targetModel(): ?TargetModel {
     return this._targetModel;
   }
 
   /**
    */
-  createModel(): ModularUIModel {
-    const Model = this.targetModel || resolveModel(this.response);
+  set forceTargetModel(forceTargetModel: boolean) {
+    this._forceTargetModel = forceTargetModel ?? false;
+  }
+
+  /**
+   */
+  get forceTargetModel(): boolean {
+    return this._forceTargetModel;
+  }
+
+  /**
+   */
+  resolveModel(): Class<ModularUIModel> {
+    let availableModels;
+    if (this.targetModel) {
+      availableModels = Array.isArray(this.targetModel)
+        ? [...this.targetModel]
+        : [this.targetModel];
+
+      if (this.forceTargetModel) {
+        return availableModels[0];
+      }
+    }
+
+    const Model: Class<ModularUIModel> | null = resolveModel(
+      this.response,
+      availableModels
+    );
 
-    // check for ResourceModel
     if (Model && Model.isApplicableModel) {
-      return new Model(this.response);
+      return Model;
+    }
+
+    if (availableModels) {
+      throw new IllegalStateException(
+        `data for ${this.href.toString()} is not applicable for model(s): ${availableModels
+          .map((m) => m.modelName)
+          .join(", ")}, received response: ${JSON.stringify(this.response)}`
+      );
     }
 
     throw new IllegalStateException(
-      `No model available for data: ${JSON.stringify(this.response)}`
+      `no javascript model is applicable for received request of ${this.href.toString()}, with response: ${JSON.stringify(
+        this.response
+      )}`
     );
   }
 
+  /**
+   */
+  createModel(): ModularUIModel {
+    const Model = this.resolveModel();
+    return new Model(this.response);
+  }
+
   /**
    */
   processContributionsService(contributionsData: Object): void {
@@ -274,7 +341,7 @@ class ModularUIRequest {
    */
   fetchDataService(): Promise<any> {
     return universalFetch({
-      ...this.options,
+      ...this.requestOptions,
       url: `${BASE}${this.href.path}`,
       params: this.href.getQuerystringForModularUI(),
       locale: this.options.locale,
@@ -451,7 +518,7 @@ class ModularUIRequest {
     );
 
     return universalFetch({
-      ...this.options,
+      ...this.requestOptions,
       url: `${BASE}${href}`,
     })
       .then((response: Object) => {
@@ -519,10 +586,9 @@ class ModularUIRequest {
     ) {
       const validationHref = this.href.setParameter("commit", "false");
       return universalFetch({
-        ...this.options,
+        ...this.requestOptions,
         url: `${BASE}${this.href.path}`,
         params: validationHref.getQuerystringForModularUI(),
-        childmodels: false,
         data: this.getDynamicValidationData(model),
       }).then((data) => {
         if (data == null || typeof data !== "object") {

package/src/modularui/__tests__/ModularUIRequest.spec.js

@@ -115,17 +115,12 @@ describe("modularUIRequest", () => {
     expect(requestWithChildModels.withChildModels).toBe(true);
   });
 
-  it("can create a model from a targetModel", () => {
+  it("Throws when data is missing", () => {
     const requestWithTargetModel = new ModularUIRequest("/");
     requestWithTargetModel.targetModel = ApplicationModel;
-
-    const model = requestWithTargetModel.createModel();
-    expect(model).toBeInstanceOf(ApplicationModel);
-
-    const wrongTargetModel = new ModularUIRequest("/");
-    wrongTargetModel.targetModel = Href;
-
-    expect(() => wrongTargetModel.createModel()).toThrow(IllegalStateException);
+    expect(() => requestWithTargetModel.createModel()).toThrow(
+      IllegalArgumentException
+    );
   });
 
   it("creates a model from a response", () => {

package/src/modularui/types.js

@@ -0,0 +1,4 @@
+// @flow
+import type { ModularUIModel } from "../models";
+
+export type TargetModel = Class<ModularUIModel> | Array<Class<ModularUIModel>>;