@beinformed/ui 1.59.21 → 1.59.23

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

@@ -0,0 +1,209 @@
+/**
+ * Form Object
+ */
+export default class FormObjectModel extends BaseModel {
+    /**
+     */
+    static createEmpty(formObjectModel: FormObjectModel): FormObjectModel;
+    _attributeCollection: AttributeCollection;
+    _contentConfiguration: ContentConfiguration;
+    _errorCollection: ErrorCollection;
+    _repeatIndex: number;
+    _dynamicValidationsLoaded: boolean;
+    /**
+     */
+    equals(object: FormObjectModel | null, withRepeatIndex?: boolean): boolean;
+    /**
+     */
+    getAttributeByAttribute(attribute: AttributeType): AttributeType | null;
+    /**
+     */
+    getAttributeByKey(key: string): AttributeType | null;
+    /**
+     */
+    hasAttributeByKey(key: string): boolean;
+    /**
+     * Get elements from both the missing attributes and the result attributes
+     */
+    getElements(): Array<Object>;
+    /**
+     * Map available contributions on the available data. Only use contributions that are needed for the data
+     */
+    getApplicableAttributeContributions(): Array<Object>;
+    /**
+     * Recursevily check if an attribute id occurs in the tree of attribute contributions.
+     * The complete leaf of the tree is returned when an attribute id matches
+     */
+    getAttributesInData(dataElementIds: Array<string>, attributesContributions: Object): Array<Object>;
+    /**
+     */
+    getInitialChildModelLinks(): Array<LinkModel>;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
+    /**
+     * get key
+     */
+    get key(): string;
+    /**
+     * Get content configuration for form objects
+     */
+    get contentConfiguration(): ContentConfiguration;
+    /**
+     */
+    get hasEndResultConfiguration(): boolean;
+    /**
+     * 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;
+    /**
+     */
+    get hasDynamicValidations(): boolean;
+    /**
+     * Indicates if object is repeatable
+     */
+    get isRepeatable(): boolean;
+    /**
+     */
+    set repeatIndex(repeatIndex: number);
+    /**
+     */
+    get repeatIndex(): number;
+    /**
+     */
+    get maxRepeats(): number;
+    /**
+     */
+    get hasFixedNrOfRepeats(): boolean;
+    /**
+     */
+    get isRepeatWithUnknownTotal(): boolean;
+    /**
+     */
+    get isLastRepeat(): boolean;
+    /**
+     */
+    get repeatIndexLabel(): string | null;
+    /**
+     * Get label of form object
+     */
+    get label(): string;
+    /**
+     * Get introText of form object
+     */
+    get introText(): string;
+    /**
+     * Get assistent of form object
+     */
+    get assistent(): string;
+    /**
+     * Get button labels
+     */
+    get buttonLabels(): Object;
+    /**
+     */
+    set attributeCollection(attributeCollection: AttributeCollection);
+    /**
+     * get attribute collection
+     */
+    get attributeCollection(): AttributeCollection;
+    /**
+     */
+    mergeObject(oldObject: FormObjectModel): void;
+    /**
+     * Update attribute
+     */
+    updateAttribute(attribute: AttributeType, value: any): AttributeType;
+    /**
+     * Inidicates if Form is changed since a given timestamp (Date.now)
+     */
+    isChangedSince(timestamp: number): boolean;
+    /**
+     * Reset all errors on Form Object
+     */
+    resetErrors(): void;
+    /**
+     * Get error messages
+     */
+    get errorCollection(): ErrorCollection;
+    /**
+     * Registers an error that was received from a server response
+     */
+    addServerError(error: FormErrorAnchor): void;
+    /**
+     */
+    hasServerErrors(): boolean;
+    /**
+     */
+    hasErrors(): boolean;
+    /**
+     */
+    get isValid(): boolean;
+    /**
+     */
+    set dynamicValidationsLoaded(dynamicValidationsLoaded: boolean);
+    /**
+     */
+    get dynamicValidationsLoaded(): boolean;
+    /**
+     * 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;
+            }>;
+            objectid?: string;
+        } | {
+            anchor: {
+                elementid: string;
+                objectid?: string;
+            };
+        }>;
+    }): void;
+    /**
+     */
+    updateValidations(data: any): FormObjectModel;
+    /**
+     * Generate formdata object for current formobject based on formdata of attributes
+     */
+    get formdata(): {
+        [string]: any;
+    } | null;
+    /**
+     */
+    getFormData(validationData?: boolean): {
+        [string]: any;
+    } | null;
+}
+import BaseModel from "../base/BaseModel";
+import AttributeCollection from "../attributes/AttributeCollection";
+import ContentConfiguration from "../contentconfiguration/ContentConfiguration";
+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/lib/models/grouping/GroupingModel.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Group information model
+ * Put GroupModel here because of possible circular dependency with GroupingModel below
+ */
+export class GroupModel {
+    /**
+     */
+    constructor(group: Object, context: Object, contributions: Array<Object>, modelOptions?: ModelOptions);
+    _group: Object;
+    _context: Object;
+    _attributeCollection: AttributeCollection;
+    _grouping: GroupingModel | null;
+    /**
+     */
+    get type(): string;
+    /**
+     */
+    get id(): string;
+    /**
+     */
+    get label(): string;
+    /**
+     */
+    get attributeCollection(): AttributeCollection;
+    /**
+     */
+    get grouping(): GroupingModel | null;
+    /**
+     * Retrieve array of reference id's
+     */
+    get reference(): Array<number>;
+    /**
+     */
+    hasAttributeByKey(key: string): boolean;
+    /**
+     */
+    getAttributeByKey(key: string): AttributeType | null;
+}
+/**
+ * Grouping model to group lists
+ */
+export default class GroupingModel {
+    /**
+     */
+    constructor(data: Object, contexts: Array<Context>, modelOptions?: ModelOptions);
+    _prefix: string | null;
+    _groups: Array<GroupModel>;
+    /**
+     */
+    createGroup(data: Object, contributions: Array<Context>, modelOptions?: ModelOptions): Array<Object>;
+    /**
+     * add grouped prefix to the dynamicschema
+     */
+    getDynamicSchema(group: Object, dynamicschema: Object): Object;
+    /**
+     * Retrieve groups of grouping
+     */
+    get groups(): Array<GroupModel>;
+    /**
+     * Inidicates if Grouping has one or more groups
+     */
+    hasGroups(): boolean;
+    /**
+     * Get context of grouping
+     */
+    getContextFromContributionsByPrefix(contexts: Array<Object>, prefix: string | null): Object;
+    /**
+     */
+    hasAttributeByKey(key: string): boolean;
+    /**
+     */
+    getAttributeByKey(key: string): AttributeType | null;
+    /**
+     */
+    getGroupByAttributeKey(key: string): GroupModel | null;
+}
+import AttributeCollection from "../attributes/AttributeCollection";
+import { AttributeType } from "../types";
+import { ModelOptions } from "../types";
+type Context = {
+    prefix: string;
+    label: string;
+    metadata: Object;
+    attributes: Object[];
+};
+export {};

package/lib/models/href/Href.d.ts

@@ -0,0 +1,218 @@
+type HrefInput = any;
+export default Href;
+/**
+ * Defines a Href with the parameters
+ */
+declare class Href {
+    /**
+     * check if the path is referencing a camel route
+     */
+    static isCamelRoute(path: string): boolean;
+    /**
+     */
+    static checkAbsoluteUrl(href: string): boolean;
+    /**
+     * Retrieve the relative path part of a href string, e.g. https://www.beinformed.com/BeInformed/tab/view?q=url => /tab/view
+     */
+    static getPathFromString(href: string): string;
+    /**
+     * Retrieve hash of href string
+     */
+    static getHashFromString(href?: string): string;
+    /**
+     * Create a Href
+     */
+    constructor(href?: HrefInput, resourcetype?: string, modelOptions?: ModelOptions | null);
+    _path: string;
+    _hash: string;
+    _parameters: Array<Parameter>;
+    _resourcetype: string;
+    _method: $Keys<typeof HTTP_METHODS>;
+    _state: any;
+    _referenceHash: number | null;
+    _origin: string;
+    _contextPath: string;
+    /**
+     * Set resourctype
+     */
+    set resourcetype(resourcetype: string);
+    /**
+     * Retrieve resourceType
+     */
+    get resourcetype(): string;
+    /**
+     * Set the origin (e.g. http://example.com:18080)
+     */
+    set origin(origin: string);
+    /**
+     * Retrieve the origin (e.g. http://example.com:18080)<br>
+     * Empty when the default must be used
+     */
+    get origin(): string;
+    /**
+     * Set the context path if different from default
+     */
+    set contextPath(contextPath: string);
+    /**
+     * Get the context path
+     */
+    get contextPath(): string;
+    /**
+     * Set parameters from Href model input
+     */
+    setFromHref(href: Href): void;
+    /**
+     * Set the path of the Href, the part before the querystring question mark
+     */
+    set path(path: string);
+    /**
+     * Retrieve the path
+     */
+    get path(): string;
+    /**
+     * Replace parameters of Href
+     */
+    set parameters(parameters: Array<Parameter>);
+    /**
+     * Retrieve all paremters
+     */
+    get parameters(): Array<Parameter>;
+    /**
+     * Set hash
+     */
+    set hash(hash: string);
+    /**
+     * Retrieve hash
+     */
+    get hash(): string;
+    /**
+     */
+    set state(state: any);
+    /**
+     */
+    get state(): any;
+    /**
+     */
+    setFromLocationOrObject(href: LocationShape | HrefObject): void;
+    /**
+     */
+    setStateFromLocationOrObject(state?: any): void;
+    /**
+     * Set parameters from string input
+     */
+    setFromString(href: string): void;
+    /**
+     */
+    get isChangePassword(): boolean;
+    /**
+     */
+    get isExternal(): boolean;
+    /**
+     * Add a parameter for each parameter found in the querystring of an URL string, e.g. https://www.beinformed.com?q=url => q=url
+     */
+    addParametersFromString(href: string): Href;
+    /**
+     * Add a querystring parameter to the parameter collection of this Href, skips parameters that have a value of null
+     */
+    addParameter(name: string, value: string | null, prefix: string | null): Href;
+    /**
+     * Adds or overwrites a parameter when it exists and value is not null.
+     * Removes the parameter when the value is null
+     */
+    setParameter(name: string, value: string | null, prefix: string | null): Href;
+    /**
+     * Retrieve a parameter by it's name and (optionally) prefix
+     */
+    getParameter(name: string, prefix: string | null): Parameter | null;
+    /**
+     */
+    hasParameter(name: string, prefix: string | null): boolean;
+    /**
+     * Set request method
+     */
+    set method(method: $Keys<typeof HTTP_METHODS>);
+    /**
+     * Get request method
+     */
+    get method(): $Keys<typeof HTTP_METHODS>;
+    /**
+     * Remove a parameter from the parameter collection
+     */
+    removeParameter(name: string, prefix: string | null, value: string | null): Href;
+    /**
+     * Get the parameters as a querystring, e.g. param1=value1&param2=value2, optionally with prefix
+     */
+    getQuerystring(withPrefix?: boolean): string;
+    /**
+     * Retrieve a querystring that only contains parameter that can be send to the modular ui, parameters are filtered by prefix
+     */
+    getQuerystringForModularUI(prefix?: string): string;
+    /**
+     * Retrieve all parameters from the parameter collection in a querystring style name1=value1&name2=value2, without the prefix
+     */
+    get querystring(): string;
+    /**
+     */
+    setState(state: any): Href;
+    /**
+     * Retrieve the path combined with the base path (context-path) of the application, e.g. /BeInformed
+     */
+    get absolutepath(): string;
+    /**
+     * Retrieves the combination of the path and the querystring
+     */
+    get href(): string;
+    /**
+     * Getting the URL including the base path, querystring is prefixed
+     */
+    get absolutehref(): string;
+    /**
+     * Getting the URL including the base path, the querystring is prefixed
+     */
+    get absolutehrefPrefixedQuerystring(): string;
+    /**
+     * Checks if the URL starts within the given href
+     */
+    startsWith(href: Href | string): boolean;
+    /**
+     * Checks if the given Href equals this Href
+     */
+    equals(href: Href | string | null): boolean;
+    /**
+     */
+    equalsWithParameters(other: Href | string | null): boolean;
+    /**
+     * Indicates if the link is a content link
+     */
+    get isContent(): boolean;
+    /**
+     */
+    getReferenceHash(): number | null;
+    /**
+     */
+    setReferenceHash(referenceHash: number): void;
+    /**
+     * Returns a complete url from the Href
+     */
+    toString(): string;
+    /**
+     */
+    toLocation(): LocationShape;
+}
+import Parameter from "../parameter/Parameter";
+import { HTTP_METHODS } from "../../constants";
+type HrefObject = {
+    _path: string;
+    _hash: string;
+    _parameters: Parameter[];
+    _resourcetype: string;
+    _method: $Keys<{
+        POST: string;
+        GET: string;
+    }>;
+    _state: {
+        [key: string]: any;
+    } | null;
+    pathname: string | null;
+};
+import { ModelOptions } from "../types";

package/lib/models/href/ListHref.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Class representing the href of a list. It adds paging, sorting and filter parameters where necessary
+ *
+ * @augments Href
+ */
+export default class ListHref extends Href {
+    /**
+     * Create a ListHref
+     */
+    constructor(href?: HrefInput, list?: ListModel, isPrefixed?: boolean);
+    _isPrefixed: boolean;
+    _prefix: string | null;
+    _pagingName: string;
+    _pagesizeName: string;
+    _sortingName: string;
+    /**
+     * Retrieve parameter names from Href
+     */
+    setParameterNamesFromHref(href: ListHref): void;
+    /**
+     * Retrieve parameter names and settings from List model
+     */
+    setParameterNamesFromListModel(list: ListModel): void;
+    /**
+     * Setting the current page
+     */
+    set page(page: number | null);
+    /**
+     */
+    get page(): Parameter | null;
+    /**
+     * Setting the page size
+     */
+    set pagesize(pagesize: number | null);
+    /**
+     * Setting the sort value
+     */
+    set sort(sort: string | null);
+    /**
+     * Add filter parameters to the parameter collection
+     */
+    set filterCollection(filters: FilterCollection);
+    /**
+     * Getting prefix
+     */
+    get prefix(): string | null;
+    /**
+     * Getting paging name
+     */
+    get pagingName(): string;
+    /**
+     * Getting pagesize name
+     */
+    get pagesizeName(): string;
+    /**
+     * Getting sorting name
+     */
+    get sortingName(): string;
+}
+import Href from "./Href";
+import ListModel from "../list/ListModel";
+import Parameter from "../parameter/Parameter";
+import FilterCollection from "../filters/FilterCollection";
+import { HrefInput } from "./Href";

package/lib/models/index.d.ts

@@ -0,0 +1,96 @@
+export { default as resolveModel } from "./resolveModel";
+export { default as BaseCollection } from "./base/BaseCollection";
+export { default as ActionCollection } from "./actions/ActionCollection";
+export { default as ActionModel } from "./actions/ActionModel";
+export { default as AttributeCollection } from "./attributes/AttributeCollection";
+export { default as AttributeSetModel } from "./attributes/AttributeSetModel";
+export { default as AttributeModel } from "./attributes/AttributeModel";
+export { default as ChoiceAttributeOptionCollection } from "./attributes/ChoiceAttributeOptionCollection";
+export { default as ChoiceAttributeOptionModel } from "./attributes/ChoiceAttributeOptionModel";
+export { default as CompositeAttributeChildCollection } from "./attributes/CompositeAttributeChildCollection";
+export { default as AttributeContent } from "./attributes/AttributeContent";
+export { default as BaseLayoutHintRule } from "./attributes/layouthint-rules/BaseLayoutHintRule";
+export { default as DependentAttribute } from "./attributes/layouthint-rules/DependentAttribute";
+export { default as RemainingTotalUploadSize } from "./attributes/layouthint-rules/RemainingTotalUploadSize";
+export { default as ConceptLinkModel } from "./concepts/ConceptLinkModel";
+export { default as ConceptRelationCollection } from "./concepts/ConceptRelationCollection";
+export { default as ConceptRelationModel } from "./concepts/ConceptRelationModel";
+export { default as SourceReferenceCollection } from "./concepts/SourceReferenceCollection";
+export { default as SourceReferenceModel } from "./concepts/SourceReferenceModel";
+export { default as ConstraintCollection } from "./attributes/input-constraints/ConstraintCollection";
+export { default as ConstraintModel } from "./attributes/input-constraints/ConstraintModel";
+export { default as ContentLinkModel } from "./content/ContentLinkModel";
+export { default as SectionModel } from "./content/SectionModel";
+export { default as SubSectionModel } from "./content/SubSectionModel";
+export { default as ContentConfiguration } from "./contentconfiguration/ContentConfiguration";
+export { default as ContentConfigurationElements } from "./contentconfiguration/ContentConfigurationElements";
+export { default as ContentConfigurationEndResults } from "./contentconfiguration/ContentConfigurationEndResults";
+export { default as ContentConfigurationQuestions } from "./contentconfiguration/ContentConfigurationQuestions";
+export { default as ContentConfigurationResults } from "./contentconfiguration/ContentConfigurationResults";
+export { default as ErrorCollection } from "./error/ErrorCollection";
+export { default as ErrorModel } from "./error/ErrorModel";
+export { default as ErrorResponse } from "./error/ErrorResponse";
+export { default as FilterCollection } from "./filters/FilterCollection";
+export { default as FormObjectModel } from "./form/FormObjectModel";
+export { default as Href } from "./href/Href";
+export { default as ListHref } from "./href/ListHref";
+export { default as LinkCollection } from "./links/LinkCollection";
+export { default as LinkModel } from "./links/LinkModel";
+export { default as ListHeaderModel } from "./list/ListHeaderModel";
+export { default as ListItemCollection } from "./list/ListItemCollection";
+export { default as ListItemModel } from "./list/ListItemModel";
+export { default as LookupOptionsModel } from "./lookup/LookupOptionsModel";
+export { default as LookupOptionCollection } from "./lookup/LookupOptionCollection";
+export { default as ModelCategory } from "./modelcatalog/ModelCategoryModel";
+export { default as ProcessStatusSettingsModel } from "./process/ProcessStatusSettingsModel";
+export { default as PagesizeModel } from "./paging/PagesizeModel";
+export { default as PagingModel } from "./paging/PagingModel";
+export { default as Parameter } from "./parameter/Parameter";
+export { default as SortingModel } from "./sorting/SortingModel";
+export { default as SortOptionModel } from "./sorting/SortOptionModel";
+export { default as TaskGroupCollection } from "./taskgroup/TaskGroupCollection";
+export type * from "./types";
+import { default as ApplicationModel } from "./application/ApplicationModel";
+import { default as CaseSearchModel } from "./search/CaseSearchModel";
+import { default as CaseViewModel } from "./caseview/CaseViewModel";
+import { default as ListDetailModel } from "./list/ListDetailModel";
+import { default as DetailModel } from "./detail/DetailModel";
+import { default as FormModel } from "./form/FormModel";
+import { default as GroupingPanelModel } from "./panels/GroupingPanelModel";
+import { default as ListModel } from "./list/ListModel";
+import { default as TabModel } from "./tab/TabModel";
+import { default as TaskGroupModel } from "./taskgroup/TaskGroupModel";
+import { default as UserModel } from "./user/UserModel";
+import { default as UserProfileModel } from "./user/UserProfileModel";
+import { default as UserServicesModel } from "./user/UserServicesModel";
+import { default as ModelCatalogModel } from "./modelcatalog/ModelCatalogModel";
+import { default as ConceptIndexModel } from "./concepts/ConceptIndexModel";
+import { default as ConceptDetailModel } from "./concepts/ConceptDetailModel";
+import { default as BusinessScenarioModel } from "./concepts/BusinessScenarioModel";
+import { default as ConceptTypeDetailModel } from "./concepts/ConceptTypeDetailModel";
+import { default as ContentIndexModel } from "./content/ContentIndexModel";
+import { default as ContentTOCModel } from "./content/ContentTOCModel";
+import { default as ContentModel } from "./content/ContentModel";
+import { default as ContentTypeModel } from "./content/ContentTypeModel";
+import { default as BooleanAttributeModel } from "./attributes/BooleanAttributeModel";
+import { default as CaptchaAttributeModel } from "./attributes/CaptchaAttributeModel";
+import { default as ChoiceAttributeModel } from "./attributes/ChoiceAttributeModel";
+import { default as DatetimeAttributeModel } from "./attributes/DatetimeAttributeModel";
+import { default as HelptextAttributeModel } from "./attributes/HelptextAttributeModel";
+import { default as LabelAttributeModel } from "./attributes/LabelAttributeModel";
+import { default as MemoAttributeModel } from "./attributes/MemoAttributeModel";
+import { default as MoneyAttributeModel } from "./attributes/MoneyAttributeModel";
+import { default as NumberAttributeModel } from "./attributes/NumberAttributeModel";
+import { default as PasswordAttributeModel } from "./attributes/PasswordAttributeModel";
+import { default as CompositeAttributeModel } from "./attributes/CompositeAttributeModel";
+import { default as StringAttributeModel } from "./attributes/StringAttributeModel";
+import { default as UploadAttributeModel } from "./attributes/UploadAttributeModel";
+import { default as XMLAttributeModel } from "./attributes/XMLAttributeModel";
+import { default as AssignmentFilterModel } from "./filters/AssignmentFilterModel";
+import { default as FilterModel } from "./filters/FilterModel";
+import { default as RangeFilterModel } from "./filters/RangeFilterModel";
+import { default as ConceptIndexFilterModel } from "./filters/ConceptIndexFilterModel";
+import { default as LayoutHintCollection } from "./layouthint/LayoutHintCollection";
+export { ApplicationModel, CaseSearchModel, CaseViewModel, ListDetailModel, DetailModel, FormModel, GroupingPanelModel, ListModel, TabModel, TaskGroupModel, UserModel, UserProfileModel, UserServicesModel, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, BusinessScenarioModel, ConceptTypeDetailModel, ContentIndexModel, ContentTOCModel, ContentModel, ContentTypeModel, BooleanAttributeModel, CaptchaAttributeModel, ChoiceAttributeModel, DatetimeAttributeModel, HelptextAttributeModel, LabelAttributeModel, MemoAttributeModel, MoneyAttributeModel, NumberAttributeModel, PasswordAttributeModel, CompositeAttributeModel, StringAttributeModel, UploadAttributeModel, XMLAttributeModel, AssignmentFilterModel, FilterModel, RangeFilterModel, ConceptIndexFilterModel, LayoutHintCollection };
+export { default as LayoutHintRuleCollection, addLayoutHintRule, updateLayoutHintRules } from "./attributes/layouthint-rules/LayoutHintRuleCollection";
+export { default as GroupingModel, GroupModel } from "./grouping/GroupingModel";