@beinformed/ui 1.25.2 → 1.25.5

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";
 
 /**
  */
@@ -90,11 +90,12 @@ const loadModelSuccessAction = (
 };
 
 /**
+ * This action is handled by the modularui middleware
  */
 export const loadModel = (
   key: string,
   href: Href | string,
-  options?: RequestBaseOptions
+  options?: RequestModularUIOptions
 ): ModularUIAction => ({
   type: "MODULARUI/FETCH",
   payload: {
@@ -104,6 +105,7 @@ export const loadModel = (
     locale: options?.locale ?? "en",
     childmodels: options?.childmodels,
     targetModel: options?.targetModel,
+    forceTargetModel: options?.forceTargetModel,
     /**
      */
     successAction: (model) =>
@@ -131,7 +133,7 @@ export const loadModularUI =
   (
     key: string,
     href: Href | string,
-    options?: RequestBaseOptions
+    options?: RequestModularUIOptions
   ): ThunkAction =>
   (dispatch: Dispatch) => {
     dispatch(updateStatus(key, MODULARUI_STATUS.LOADING));
@@ -154,7 +156,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,15 @@ type RequestOptions = {
   data?: string | { [key: string]: string },
   locale: string,
   childmodels?: boolean,
-  targetModel?: Class<ModularUIModel>,
+  targetModel?: TargetModel,
+  forceTargetModel?: boolean,
   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 || {},
@@ -41,6 +43,7 @@ const createRequest = (modularui: RequestOptions) => {
 
   if (modularui.targetModel) {
     request.targetModel = modularui.targetModel;
+    request.forceTargetModel = modularui.forceTargetModel ?? false;
   }
 
   return request;

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,8 @@ export type ModularUIAction = {
     data?: string | { [key: string]: string },
     locale: string,
     childmodels?: boolean,
-    targetModel?: Class<ModularUIModel>,
+    targetModel?: TargetModel,
+    forceTargetModel?: boolean,
     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,
+  forceTargetModel?: boolean,
+  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 = {

package/types/modularui/ModularUIRequest.d.ts

@@ -6,11 +6,11 @@ export default ModularUIRequest;
 declare class ModularUIRequest {
     /**
      */
-    constructor(href: Href | string, options?: $Shape<RequestBaseOptions>);
+    constructor(href: Href | string, options?: $Shape<RequestModularUIOptions>);
     _response: ModularUIResponse;
     _href: Href;
-    _options: RequestBaseOptions;
-    _targetModel: Class<ModularUIModel>;
+    _options: RequestModularUIOptions;
+    _targetModel: TargetModel | null;
     _contributionsHref: string;
     _locale: string;
     _method: $Keys<{
@@ -20,10 +20,10 @@ declare class ModularUIRequest {
     _progressEvent: ProgressEventHandler;
     /**
      */
-    set options(arg: RequestBaseOptions);
+    set options(arg: RequestModularUIOptions);
     /**
      */
-    get options(): RequestBaseOptions;
+    get options(): RequestModularUIOptions;
     /**
      */
     set href(arg: Href);
@@ -38,10 +38,10 @@ declare class ModularUIRequest {
     get locale(): string;
     /**
      */
-    set targetModel(arg: Class<ModularUIModel>);
+    set targetModel(arg: any);
     /**
      */
-    get targetModel(): Class<ModularUIModel>;
+    get targetModel(): any;
     /**
      */
     set method(arg: $Keys<{
@@ -63,9 +63,15 @@ declare class ModularUIRequest {
     /**
      */
     get response(): ModularUIResponse;
+    /**
+     */
+    get requestOptions(): RequestBaseOptions;
     /**
      */
     get withChildModels(): boolean;
+    /**
+     */
+    resolveModel(): Class<ModularUIModel>;
     /**
      */
     createModel(): ModularUIModel;
@@ -171,6 +177,8 @@ declare class ModularUIRequest {
 }
 import ModularUIResponse from "./ModularUIResponse";
 import Href from "../models/href/Href";
+import { RequestModularUIOptions } from "../utils/fetch/types";
+import { TargetModel } from "./types";
 import { RequestBaseOptions } from "../utils/fetch/types";
 import { ModularUIModel } from "../models/types";
 import ContentModel from "../models/content/ContentModel";

package/types/modularui/types.d.ts

@@ -0,0 +1,2 @@
+type TargetModel = any;
+export {};

package/types/redux/_modularui/types.d.ts

@@ -1,7 +1,7 @@
 type ModularUIOptions = {
     propName?: string;
     removeOnUnmount?: boolean;
-    RequestBaseOptions: any;
+    RequestModularUIOptions: any;
 };
 type ModelEntry = {};
 type ModularUIState = {};
@@ -28,7 +28,7 @@ type ModularUIAction = {
         };
         locale: string;
         childmodels?: boolean;
-        targetModel?: Class<ModularUIModel>;
+        targetModel?: any;
         successAction: (model: ModularUIModel) => SetModelAction | UpdateModelAction;
         errorAction?: ErrorAction;
     };

package/types/utils/fetch/types.d.ts

@@ -24,15 +24,18 @@ type RequestBaseOptions = {
     includeContext?: boolean;
     locale?: string;
     cache?: boolean;
-    childmodels?: boolean;
-    isValidationRequest?: boolean;
-    targetModel?: Class<ModularUIModel>;
-    updateModel?: ModularUIModel;
     isReload?: boolean;
-    removeOnUnmount?: boolean;
 };
 type RequestOptions = {
     RequestURLOptions: any;
     RequestBaseOptions: any;
 };
+type RequestModularUIOptions = {
+    RequestBaseOptions: any;
+    targetModel?: any;
+    updateModel?: ModularUIModel;
+    childmodels?: boolean;
+    isValidationRequest?: boolean;
+    removeOnUnmount?: boolean;
+};
 export {};