@beinformed/ui 1.48.1 → 1.49.3

package/src/utils/fetch/types.js

@@ -31,11 +31,12 @@ export type RequestBaseOptions = {
 
 export type RequestOptions = { ...RequestURLOptions, ...RequestBaseOptions };
 
+export type UpdateHandler = (newModel: ModularUIModel) => ModularUIModel;
 export type RequestModularUIOptions = {
   ...RequestBaseOptions,
   targetModel?: TargetModel,
   forceTargetModel?: boolean,
-  updateModel?: ModularUIModel,
+  updateHandler?: UpdateHandler | void,
   childmodels?: boolean,
   isValidationRequest?: boolean,
   removeOnUnmount?: boolean,

package/types/hooks/useI18n.d.ts

@@ -1,6 +1,6 @@
 /**
  */
-export function useTranslate(): (...any: any[]) => any;
+export function useTranslate(): ((...any) => any);
 /**
  */
 export function useMessage(id: string, defaultMessage?: string, placeholders?: Object | null): any;

package/types/models/application/ApplicationModel.d.ts

@@ -3,6 +3,9 @@
  */
 export default class ApplicationModel extends ResourceModel {
     _userServices: UserServicesModel | null;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
     /**
      * Set the userservices for this application
      */
@@ -32,9 +35,13 @@ export default class ApplicationModel extends ResourceModel {
      * only available when the user services are available
      */
     get userHref(): Href;
+    /**
+     */
+    get userMustChangePassword(): boolean;
 }
 import ResourceModel from "../base/ResourceModel";
 import UserServicesModel from "../user/UserServicesModel";
+import { ModularUIModel } from "../types";
 import { AuthenticationType } from "../types";
 import LinkCollection from "../links/LinkCollection";
 import LinkModel from "../links/LinkModel";

package/types/models/attributes/AttributeModel.d.ts

@@ -36,7 +36,7 @@ export default class AttributeModel extends BaseModel {
     getInitialChildModelLinks(): Array<LinkModel>;
     /**
      */
-    setChildModels(models: Array<ModularUIModel>): void;
+    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
     /**
      * Set the concept
      */
@@ -281,7 +281,7 @@ export default class AttributeModel extends BaseModel {
     /**
      * Registers a missing error that was received from the server
      */
-    addMissingError(): void;
+    addMissingError(receivedAttribute?: AttributeType): void;
     /**
      */
     removeMissingError(): void;
@@ -386,10 +386,11 @@ import LinkCollection from "../links/LinkCollection";
 import LayoutHintRuleCollection from "./layouthint-rules/LayoutHintRuleCollection";
 import LinkModel from "../links/LinkModel";
 import { ModularUIModel } from "../types";
+import ErrorResponse from "../error/ErrorResponse";
 import ContentConfiguration from "../contentconfiguration/ContentConfiguration";
 import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";
 import { FormErrorAnchor } from "../types";
-import { MessageParameters } from "../../i18n/types";
 import { AttributeType } from "../types";
+import { MessageParameters } from "../../i18n/types";
 import AttributeCollection from "./AttributeCollection";
 import AttributeContent from "./AttributeContent";

package/types/models/attributes/ChoiceAttributeModel.d.ts

@@ -60,6 +60,9 @@ export default class ChoiceAttributeModel extends AttributeModel {
      * Check if options need to be rendered as tree
      */
     get isTree(): boolean;
+    /**
+     */
+    mergeAttribute(oldAttribute: AttributeType, addNotExistingOptions?: boolean, removeNotExistingOptions?: boolean): void;
     /**
      * Update attribute by name and value
      */
@@ -78,4 +81,5 @@ export default class ChoiceAttributeModel extends AttributeModel {
 import AttributeModel from "./AttributeModel";
 import ChoiceAttributeOptionCollection from "./ChoiceAttributeOptionCollection";
 import LinkModel from "../links/LinkModel";
+import { AttributeType } from "../types";
 import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";

package/types/models/attributes/ChoiceAttributeOptionCollection.d.ts

@@ -72,7 +72,7 @@ declare class ChoiceAttributeOptionCollection extends ResourceCollection<ChoiceA
     get headers(): ListHeaderModel[];
     /**
      */
-    mergeOptions(withOptions: ChoiceAttributeOptionCollection, addNotExistingOptions?: boolean): void;
+    mergeOptions(withOptions: ChoiceAttributeOptionCollection, addNotExistingOptions?: boolean, removeNotExistingOptions?: boolean): void;
 }
 import ChoiceAttributeOptionModel from "./ChoiceAttributeOptionModel";
 import ResourceCollection from "../base/ResourceCollection";

package/types/models/attributes/ChoiceAttributeOptionModel.d.ts

@@ -35,7 +35,7 @@ declare class ChoiceAttributeOptionModel extends BaseModel {
     getInitialChildModelLinks(): Array<LinkModel>;
     /**
      */
-    setChildModels(models: Array<ModularUIModel>): void;
+    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
     /**
      * Set the concept
      */
@@ -143,4 +143,5 @@ import AttributeCollection from "./AttributeCollection";
 import AttributeContent from "./AttributeContent";
 import LinkModel from "../links/LinkModel";
 import { ModularUIModel } from "../types";
+import ErrorResponse from "../error/ErrorResponse";
 import ListItemModel from "../list/ListItemModel";

package/types/models/attributes/input-constraints/ConstraintModel.d.ts

@@ -5,7 +5,7 @@ export default class ConstraintModel {
      */
     constructor(id: string, validateMethod: Function | null, defaultMessage: string | null, parameters: Object | null, useClientsideValidation?: boolean);
     _id: string;
-    _validateMethod: (value: any) => boolean;
+    _validateMethod: ((value: any) => boolean) | null;
     _defaultMessage: string | null;
     _parameters: Object | null;
     _useClientsideValidation: boolean;

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

@@ -12,8 +12,9 @@ declare class ResourceCollection<T, IModelWithChildModels> extends BaseCollectio
     /**
      * Pass through models for setchildmodels to items of this collection
      */
-    setChildModels(models: Array<ModularUIModel>): void;
+    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
 }
 import BaseCollection from "./BaseCollection";
 import LinkModel from "../links/LinkModel";
 import { ModularUIModel } from "../types";
+import ErrorResponse from "../error/ErrorResponse";

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

@@ -80,7 +80,7 @@ declare class ResourceModel extends BaseModel {
     /**
      * Add child models to this model
      */
-    addChildModels(models: Array<ModularUIModel>): this;
+    addChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): this;
     /**
      * Template to set expanded child models
      * Use this hook to separate the retrieved child models into the correct models.
@@ -88,7 +88,7 @@ declare class ResourceModel extends BaseModel {
      * @abstract
      * @example <caption>Put all models of instance List and GroupingPanel into the panels property</caption>
      */
-    setChildModels(models: Array<ModularUIModel>): void;
+    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
     /**
      */
     dehydrate(): Object;
@@ -98,4 +98,5 @@ import { ModularUIModel } from "../types";
 import LinkCollection from "../links/LinkCollection";
 import LinkModel from "../links/LinkModel";
 import Href from "../href/Href";
+import ErrorResponse from "../error/ErrorResponse";
 import ModularUIResponse from "../../modularui/ModularUIResponse";

package/types/models/concepts/BusinessScenarioModel.d.ts

@@ -4,7 +4,7 @@ export default BusinessScenarioModel;
 declare class BusinessScenarioModel extends ConceptDetailModel {
     /**
      */
-    static isOfConceptType(conceptTypeHref: string | null, settingName: "STEP" | "PERSONA" | "SCENARIO"): boolean;
+    static isOfConceptType(conceptTypeHref: string | null, settingNames: Array<"STEP" | "PERSONA" | "SCENARIO" | "SYSTEM">): boolean;
     _scenarioSteps: Array<ConceptDetailModel>;
     /**
      */

package/types/models/concepts/ConceptRelationModel.d.ts

@@ -14,13 +14,12 @@ export default class ConceptRelationModel {
      */
     setChildModels(models: Array<ModularUIModel>): void;
     /**
-     * Get key of relation
      */
-    get key(): string;
+    get type(): string;
     /**
-     * Get Text fragments
+     * Get key of relation
      */
-    get textfragments(): textfragmentJSON[];
+    get key(): string;
     /**
      * Get Label of relation
      */
@@ -29,6 +28,13 @@ export default class ConceptRelationModel {
      * Get direction of relation
      */
     get direction(): string;
+    /**
+     * Get type of relation type,
+     */
+    get relationTypeType(): "None" | "Sub-Class" | "Composition" | "Association" | "Unknown";
+    /**
+     */
+    get condition(): string;
     /**
      * Set concept information
      */
@@ -37,8 +43,17 @@ export default class ConceptRelationModel {
      * Get other concept
      */
     get concept(): ConceptLinkModel;
+    /**
+     * Get Text fragments
+     */
+    get textfragments(): textfragmentJSON[];
+    /**
+     * Get Properties
+     */
+    get properties(): propertyJSON[];
 }
 import ConceptLinkModel from "./ConceptLinkModel";
 import LinkModel from "../links/LinkModel";
 import { ModularUIModel } from "../types";
 import { textfragmentJSON } from "../types";
+import { propertyJSON } from "../types";

package/types/models/content/ContentModel.d.ts

@@ -5,6 +5,9 @@ export default class ContentModel extends ResourceModel {
     _section: SectionModel;
     _contentType: ContentTypeModel | null;
     _filterCollection: FilterCollection;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
     /**
      * Set concept type
      */
@@ -69,6 +72,7 @@ import ResourceModel from "../base/ResourceModel";
 import SectionModel from "./SectionModel";
 import ContentTypeModel from "./ContentTypeModel";
 import FilterCollection from "../filters/FilterCollection";
+import { ModularUIModel } from "../types";
 import ContentLinkModel from "./ContentLinkModel";
 import SubSectionModel from "./SubSectionModel";
 import Href from "../href/Href";

package/types/models/content/ContentTOCModel.d.ts

@@ -4,6 +4,9 @@
 export default class ContentTOCModel extends ResourceModel {
     _contentType: ContentTypeModel | null;
     _filterCollection: FilterCollection;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
     /**
      */
     set contentType(contentType: ContentTypeModel);
@@ -34,4 +37,5 @@ export default class ContentTOCModel extends ResourceModel {
 import ResourceModel from "../base/ResourceModel";
 import ContentTypeModel from "./ContentTypeModel";
 import FilterCollection from "../filters/FilterCollection";
+import { ModularUIModel } from "../types";
 import ContentLinkModel from "./ContentLinkModel";

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

@@ -193,7 +193,7 @@ declare class FormModel extends ResourceModel {
      */
     getResultData(): {
         [key: string]: AttributeSetModel;
-    };
+    } | null;
     /**
      */
     get resultData(): Object;
@@ -280,6 +280,12 @@ declare class FormModel extends ResourceModel {
      * Merge existing form with new form
      */
     update(receivedForm: ModularUIModel): FormModel;
+    /**
+     * Updates the current form object with new information about the object,
+     * like for example a new dynamicschema. Used for autoupdate functionality that makes it possible
+     * to update the options of a next missing attribute in a form-tree iq question
+     */
+    updateCurrentFormObject(receivedForm: ModularUIModel): void;
     /**
      */
     updateValidations(data: any): FormModel;

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

@@ -40,7 +40,7 @@ export default class FormObjectModel extends BaseModel {
     getInitialChildModelLinks(): Array<LinkModel>;
     /**
      */
-    setChildModels(models: Array<ModularUIModel>): void;
+    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
     /**
      * get key
      */
@@ -53,7 +53,15 @@ export default class FormObjectModel extends BaseModel {
      */
     get hasEndResultConfiguration(): boolean;
     /**
-     * Indicates if object is dynamic. A dynamic object should be submitted on each attribute change
+     * Indicates if object is dynamic.
+     *
+     * A subtle difference exists between objects for wizard style instrument dialogs and other objects.
+     * In the 'missing object' response, wizard style objects will include only the first attribute(s) to be answered,
+     * while other objects will include the complete set of attributes of that object.
+     *
+     * This difference is condensed in the term of 'dynamic objects': these objects start (in the 'missing object' response)
+     * with a very select set of attributes to be answered, and each successive 'missing elements' response will include next attributes to be answered.
+     * When an object is dynamic, the form contributions will mention a "dynamicObject": true property.
      */
     get isDynamic(): boolean;
     /**
@@ -194,5 +202,6 @@ import ErrorCollection from "../error/ErrorCollection";
 import { AttributeType } from "../types";
 import LinkModel from "../links/LinkModel";
 import { ModularUIModel } from "../types";
+import ErrorResponse from "../error/ErrorResponse";
 import { FormErrorAnchor } from "../types";
 import { MessageParameters } from "../../i18n";

package/types/models/links/normalizeLinkJSON.d.ts

@@ -3,7 +3,7 @@ export default normalizeLinkJSON;
  * Normalize various link formats from services into a concistent format
  * @private
  */
-declare function normalizeLinkJSON(data: Object, contributions: Object): {
+declare function normalizeLinkJSON(data: Object, contributions: Object): Array<{
     data: any;
     contributions: any;
-}[];
+}>;

package/types/models/list/ListModel.d.ts

@@ -11,6 +11,9 @@ export default class ListModel extends ResourceModel {
     _listItemCollection: ListItemCollection;
     _grouping: GroupingModel;
     _selfhref: ListHref;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
     /**
      * Add detail model to the {ListModel}
      */
@@ -136,4 +139,5 @@ import ActionCollection from "../actions/ActionCollection";
 import ListItemCollection from "../list/ListItemCollection";
 import GroupingModel from "../grouping/GroupingModel";
 import ListHref from "../href/ListHref";
+import { ModularUIModel } from "../types";
 import ListItemModel from "../list/ListItemModel";

package/types/models/panels/GroupingPanelModel.d.ts

@@ -6,6 +6,9 @@ export default class GroupingPanelModel extends ResourceModel {
     /**
      */
     get panelLinks(): LinkCollection;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
     /**
      * Check if an introtext exists for this caseview
      */
@@ -37,3 +40,4 @@ export default class GroupingPanelModel extends ResourceModel {
 import ResourceModel from "../base/ResourceModel";
 import TaskGroupCollection from "../taskgroup/TaskGroupCollection";
 import LinkCollection from "../links/LinkCollection";
+import { ModularUIModel } from "../types";

package/types/models/tab/TabModel.d.ts

@@ -4,6 +4,9 @@
 export default class TabModel extends ResourceModel {
     _actionCollection: ActionCollection;
     _taskGroupCollection: TaskGroupCollection;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
     /**
      */
     get searchLink(): LinkModel;
@@ -40,5 +43,6 @@ export default class TabModel extends ResourceModel {
 import ResourceModel from "../base/ResourceModel";
 import ActionCollection from "../actions/ActionCollection";
 import TaskGroupCollection from "../taskgroup/TaskGroupCollection";
+import { ModularUIModel } from "../types";
 import LinkModel from "../links/LinkModel";
 import LinkCollection from "../links/LinkCollection";

package/types/models/types.d.ts

@@ -44,7 +44,7 @@ export interface ILayoutHintRule {
 }
 export interface IModelWithChildModels {
     getInitialChildModelLinks(): Array<LinkModel>;
-    setChildModels(models: Array<ModularUIModel>): void;
+    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
 }
 type AuthenticationType = {
     name: string;
@@ -158,4 +158,5 @@ type ContentData = {
 import AttributeModel from "./attributes/AttributeModel";
 import AttributeCollection from "./attributes/AttributeCollection";
 import LinkModel from "./links/LinkModel";
+import ErrorResponse from "./error/ErrorResponse";
 export {};

package/types/models/user/UserServicesModel.d.ts

@@ -4,6 +4,13 @@ export default UserServicesModel;
  */
 declare class UserServicesModel extends ResourceModel {
     _user: UserModel | null;
+    _mustChangePassword: boolean;
+    /**
+     */
+    set mustChangePassword(mustChangePassword: boolean);
+    /**
+     */
+    get mustChangePassword(): boolean;
     /**
      * Set user data
      */

package/types/redux/types.d.ts

@@ -4,6 +4,7 @@ type PreferenceValue = string | boolean | {
 type UpdateFormOptions = {
     autosubmit: boolean;
     autosave: boolean;
+    autoupdate: boolean;
     forceUpdate?: boolean;
     /** Default true: Activate/deactivate the form object validate by an update */
     validate?: boolean;

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

@@ -28,11 +28,12 @@ type RequestOptions = {
     RequestURLOptions: any;
     RequestBaseOptions: any;
 };
+type UpdateHandler = (newModel: ModularUIModel) => ModularUIModel;
 type RequestModularUIOptions = {
     RequestBaseOptions: any;
     targetModel?: any;
     forceTargetModel?: boolean;
-    updateModel?: ModularUIModel;
+    updateHandler?: void | UpdateHandler;
     childmodels?: boolean;
     isValidationRequest?: boolean;
     removeOnUnmount?: boolean;