@beinformed/ui 1.25.2 → 1.25.4

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,8 @@ class ModularUIRequest {
   _response: ModularUIResponse;
 
   _href: Href;
-  _options: RequestBaseOptions;
-  _targetModel: ?Class<ModularUIModel>;
+  _options: RequestModularUIOptions;
+  _targetModel: ?TargetModel;
   _contributionsHref: string;
   _locale: string;
   _method: $Keys<typeof HTTP_METHODS> = HTTP_METHODS.GET;
@@ -46,7 +50,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 +139,7 @@ class ModularUIRequest {
 
   /**
    */
-  get options(): RequestBaseOptions {
+  get options(): RequestModularUIOptions {
     return {
       ...this._options,
       locale: this.locale,
@@ -142,7 +149,23 @@ class ModularUIRequest {
 
   /**
    */
-  set options(options: RequestBaseOptions) {
+  get requestOptions(): RequestBaseOptions {
+    /* eslint-disable no-unused-vars */
+    const {
+      targetModel,
+      updateModel,
+      childmodels,
+      isValidationRequest,
+      removeOnUnmount,
+      ...requestOptions
+    } = this.options;
+    /* eslint-enable no-unused-vars */
+    return requestOptions;
+  }
+
+  /**
+   */
+  set options(options: RequestModularUIOptions) {
     this._options = options;
   }
 
@@ -156,31 +179,57 @@ 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);
+  resolveModel(): Class<ModularUIModel> {
+    let availableModels;
+    if (this.targetModel) {
+      availableModels = Array.isArray(this.targetModel)
+        ? [...this.targetModel]
+        : [this.targetModel];
+    }
+
+    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 is not applicable for model(s): ${availableModels
+          .map((m) => m.modelName)
+          .join(", ")}`
+      );
     }
 
     throw new IllegalStateException(
-      `No model available for data: ${JSON.stringify(this.response)}`
+      `no javascript model is applicable for received response: ${JSON.stringify(
+        this.response
+      )}`
     );
   }
 
+  /**
+   */
+  createModel(): ModularUIModel {
+    const Model = this.resolveModel();
+    return new Model(this.response);
+  }
+
   /**
    */
   processContributionsService(contributionsData: Object): void {
@@ -274,7 +323,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 +500,7 @@ class ModularUIRequest {
     );
 
     return universalFetch({
-      ...this.options,
+      ...this.requestOptions,
       url: `${BASE}${href}`,
     })
       .then((response: Object) => {
@@ -519,10 +568,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>>;

package/src/redux/_modularui/ModularUIActions.js

@@ -15,7 +15,7 @@ import type {
   ResetModularUIAction,
   UpdateStatusAction,
 } from "./types";
-import type { RequestBaseOptions } from "../../utils/fetch/types";
+import type { RequestModularUIOptions } from "../../utils/fetch/types";
 
 /**
  */
@@ -94,7 +94,7 @@ const loadModelSuccessAction = (
 export const loadModel = (
   key: string,
   href: Href | string,
-  options?: RequestBaseOptions
+  options?: RequestModularUIOptions
 ): ModularUIAction => ({
   type: "MODULARUI/FETCH",
   payload: {
@@ -131,7 +131,7 @@ export const loadModularUI =
   (
     key: string,
     href: Href | string,
-    options?: RequestBaseOptions
+    options?: RequestModularUIOptions
   ): ThunkAction =>
   (dispatch: Dispatch) => {
     dispatch(updateStatus(key, MODULARUI_STATUS.LOADING));
@@ -154,7 +154,7 @@ export const loadModularUI =
  */
 export const reloadModel = (
   model: ModularUIModel,
-  options?: RequestBaseOptions
+  options?: RequestModularUIOptions
 ): ThunkAction =>
   loadModularUI(model.connectKey, model.selfhref, {
     ...options,

package/src/redux/_modularui/ModularUIMiddleware.js

@@ -16,6 +16,7 @@ import type {
 import type { ModularUIModel } from "../../models/types";
 import type Href from "../../models/href/Href";
 import type { ModularUIAction, SuccessAction, ErrorAction } from "./types";
+import type { TargetModel } from "../../modularui/types";
 
 type RequestOptions = {
   href: Href,
@@ -23,14 +24,14 @@ type RequestOptions = {
   data?: string | { [key: string]: string },
   locale: string,
   childmodels?: boolean,
-  targetModel?: Class<ModularUIModel>,
+  targetModel?: TargetModel,
   isReload?: boolean,
 };
 
 /**
  * Symbol key that carries API call info interpreted by this Redux middleware.
  */
-const createRequest = (modularui: RequestOptions) => {
+const createRequest = (modularui: RequestOptions): ModularUIRequest => {
   const request = new ModularUIRequest(modularui.href, {
     method: modularui.method || HTTP_METHODS.GET,
     data: modularui.data || {},

package/src/redux/_modularui/types.js

@@ -7,13 +7,14 @@ import typeof {
   HTTP_METHODS,
   MODULARUI_STATUS,
 } from "../../constants/Constants";
-import type { RequestBaseOptions } from "../../utils/fetch/types";
 import type { ComponentType } from "react";
+import type { TargetModel } from "../../modularui/types";
+import type { RequestModularUIOptions } from "../../utils/fetch/types";
 
 export type ModularUIOptions = {
   propName?: string,
   removeOnUnmount?: boolean,
-  ...RequestBaseOptions,
+  ...RequestModularUIOptions,
 };
 
 export type ModelEntry = {
@@ -56,7 +57,7 @@ export type ModularUIAction = {
     data?: string | { [key: string]: string },
     locale: string,
     childmodels?: boolean,
-    targetModel?: Class<ModularUIModel>,
+    targetModel?: TargetModel,
     successAction: (
       model: ModularUIModel
     ) => UpdateModelAction | SetModelAction,

package/src/redux/_modularui/withModularUI.js

@@ -21,9 +21,9 @@ import type {
 } from "../types";
 import type Href from "../../models/href/Href";
 import type { ModularUIModel } from "../../models/types";
-import type { RequestBaseOptions } from "../../utils/fetch/types";
 import type FetchException from "../../exceptions/FetchException";
 import type { ComponentType } from "react";
+import type { RequestModularUIOptions } from "../../utils/fetch/types";
 
 type StateProps = {
   modularui: (href: Href, options: any) => ModularUIRequest,
@@ -35,7 +35,7 @@ type DispatchProps = {
   finishProgress: () => FinishProgressAction,
   reloadModel: (
     model: ModularUIModel,
-    options?: RequestBaseOptions
+    options?: RequestModularUIOptions
   ) => ThunkAction,
   handleError: (error: Error | FetchException) => ThunkAction,
 };

package/src/utils/fetch/types.js

@@ -1,10 +1,12 @@
 // @flow
 import typeof { HTTP_METHODS } from "../../constants/Constants";
 import type { ModularUIModel } from "../../models/types";
+import type { TargetModel } from "../../modularui/types";
 
 export type RequestURLOptions = {
   url: string,
 };
+
 export type RequestBaseOptions = {
   method?: $Keys<HTTP_METHODS>,
   params?: string,
@@ -24,11 +26,17 @@ export type RequestBaseOptions = {
   includeContext?: boolean,
   locale?: string,
   cache?: boolean,
+  isReload?: boolean,
+};
+
+export type RequestOptions = { ...RequestURLOptions, ...RequestBaseOptions };
+
+export type RequestModularUIOptions = {
+  ...RequestBaseOptions,
+  targetModel?: TargetModel,
+  updateModel?: ModularUIModel,
   childmodels?: boolean,
   isValidationRequest?: boolean,
-  targetModel?: Class<ModularUIModel>,
-  updateModel?: ModularUIModel,
-  isReload?: boolean,
+
   removeOnUnmount?: boolean,
 };
-export type RequestOptions = { ...RequestURLOptions, ...RequestBaseOptions };

package/types/constants/Constants.d.ts

@@ -149,3 +149,8 @@ export const LOGIN_PATH_SETTING: "FormClient.login_url";
 export const LOGIN_USERNAME_SETTING: "FormClient.username_field_name";
 export const LOGIN_PASSWORD_SETTING: "FormClient.password_field_name";
 export const LOGOUT_PATH_SETTING: "FormClient.logout_url";
+export namespace fallbackDefaultAuthenticationType {
+    const name: string;
+    const authentication: string;
+    const isPrimary: boolean;
+}

package/types/models/base/ResourceModel.d.ts

@@ -3,6 +3,10 @@ export default ResourceModel;
  * Base model, this the foundation for models that represent modular ui services, e.g. application, tab, caseview, etc
  */
 declare class ResourceModel extends BaseModel {
+    /**
+     * Property to render name of a model, is original name after transpilation
+     */
+    static get modelName(): string;
     /**
      * Returns true when the model is supported based on configuration found in contributions
      *

package/types/models/form/FormObjectModel.d.ts

@@ -145,8 +145,33 @@ export default class FormObjectModel extends BaseModel {
     /**
      */
     get dynamicValidationsLoaded(): boolean;
-    handleErrorValidations(errors: any): void;
-    handleMissingValidations(missing: any): void;
+    /**
+     * Convert error json from a form service to validation messages on the form object and attributes
+     */
+    handleErrorValidations(errors: Array<{
+        anchor: {
+            objectid: string;
+            elementid?: string;
+        };
+        id: string;
+        message: string;
+        properties: MessageParameters;
+        layouthint: Array<string>;
+    }>): void;
+    /**
+     * Convert missing json from a form service to mandatory validation constraints and messages
+     */
+    handleMissingValidations(missing: {
+        anchors: Array<{
+            elements: Array<{
+                elementid: string;
+            }>;
+        } | {
+            anchor: {
+                elementid: string;
+            };
+        }>;
+    }): void;
     /**
      */
     updateValidations(data: any): FormObjectModel;
@@ -168,3 +193,4 @@ import { AttributeType } from "../types";
 import LinkModel from "../links/LinkModel";
 import { ModularUIModel } from "../types";
 import { FormErrorAnchor } from "../types";
+import { MessageParameters } from "../../i18n/types";

package/types/models/resolveModel.d.ts

@@ -2,6 +2,6 @@ export default resolveModel;
 /**
  * Resolve a model by resource
  */
-declare function resolveModel(data: ModularUIResponse): Class<ModularUIModel> | null;
+declare function resolveModel(data: ModularUIResponse, availableModels?: Array<Class<ModularUIModel>>): Class<ModularUIModel> | null;
 import ModularUIResponse from "../modularui/ModularUIResponse";
 import { ModularUIModel } from "./types";

package/types/models/types.d.ts

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