@beinformed/ui 1.62.8 → 1.63.0

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

@@ -1,398 +0,0 @@
-/**
- * Attribute model, base model for all kind of attributes
- */
-export default class AttributeModel extends BaseModel {
-    /**
-     */
-    static isApplicableModel(contributions: Object): boolean;
-    _label: string;
-    _lastModification: number;
-    _initvalue: any;
-    _inputvalue: string;
-    _value: any;
-    _errorCollection: ErrorCollection;
-    _serverConstraints: ConstraintCollection;
-    _useClientsideValidation: boolean;
-    _isValid: boolean;
-    _validatedValue: string | null;
-    _isEditable: boolean;
-    _concept: ConceptDetailModel | null;
-    _referenceDate: ISO_DATE;
-    _isResult: boolean;
-    _isHidden: boolean;
-    _readonly: boolean;
-    _disabled: boolean;
-    _mandatory: boolean;
-    _links: LinkCollection;
-    _parentKey: string | null;
-    _hasContentConfiguration: boolean;
-    _layoutHintRules: LayoutHintRuleCollection;
-    /**
-     * Retrieve initial input value
-     */
-    getInitialInputValue(value: any): any;
-    /**
-     */
-    getInitialChildModelLinks(): Array<LinkModel>;
-    /**
-     */
-    setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>): void;
-    /**
-     * Set the concept
-     */
-    set concept(concept: ModularUIModel | null);
-    /**
-     * Get concept information
-     */
-    get concept(): ConceptDetailModel | null;
-    /**
-     * Getting the attribute key
-     */
-    get key(): string;
-    /**
-     */
-    set parentKey(parentKey: string);
-    /**
-     */
-    get parentKey(): string;
-    /**
-     * Getting the attribute name
-     */
-    get name(): string;
-    /**
-     * Getting the type of the attribute
-     */
-    get type(): string;
-    /**
-     * Set the label of this attribute
-     */
-    set label(label: string);
-    /**
-     * Getting the label of the attribute
-     */
-    get label(): string;
-    /**
-     */
-    set hasContentConfiguration(hasContentConfiguration: boolean);
-    /**
-     */
-    get hasContentConfiguration(): boolean;
-    /**
-     */
-    indicateContentConfiguration(contentConfiguration: ContentConfiguration): void;
-    /**
-     * Retrieve the first permitted label to render when a concept and contentConfiguration is available
-     * Be aware that permission could be in place for labels from a concept.
-     */
-    getContentConfiguredLabel(contentConfiguration: ContentConfigurationElements | null): string;
-    /**
-     */
-    get defaultAlignment(): "left" | "center" | "right";
-    /**
-     * Handles layout hint align-left, align-center and align-right
-     */
-    get alignment(): "left" | "center" | "right";
-    /**
-     * Retrieve links of attribute
-     */
-    get links(): LinkCollection;
-    /**
-     * Retrieve link of attribute when available
-     */
-    get downloadLink(): LinkModel | null;
-    /**
-     * Retrieve concept link of attribute when available
-     */
-    get conceptLink(): LinkModel | null;
-    /**
-     * Set reference date for concepts and content
-     */
-    set referenceDate(date: ISO_DATE);
-    /**
-     * Retrieve reference date of attribute which can be used as entryDate for content
-     * to get information in correct time version
-     */
-    get referenceDate(): ISO_DATE;
-    /**
-     * Initial value received from the modular ui service
-     */
-    get initvalue(): any;
-    /**
-     * Retrieve input value
-     */
-    getInputValue(): string;
-    /**
-     * Sets the input value to the value entered by the user
-     */
-    set inputvalue(value: string);
-    /**
-     * Returns the value as entered by the user. This can differ from the internal iso value that is stored
-     */
-    get inputvalue(): string;
-    /**
-     * Value that is used when retrieving an error collection of this attribute
-     * Mostly this is the input value, but sometimes a different value is needed,
-     * for example iban and postcode need to validate length without spaces
-     */
-    get validateValue(): string;
-    /**
-     * Setting a value in the element
-     */
-    set value(value: string | null);
-    /**
-     * Getting the value of the attribute
-     */
-    get value(): any;
-    /**
-     */
-    hasValue(): boolean;
-    /**
-     * Getting the value of the attribute
-     */
-    getValue(): any;
-    /**
-     * Getting data ready to be send to the modular ui
-     * Returns null when the attribute should not be send to the server
-     */
-    getFormData(): {
-        [string]: any;
-    } | null;
-    /**
-     */
-    get formdata(): {
-        [string]: any;
-    } | null;
-    /**
-     */
-    getEmptyFormData(): {
-        [string]: null;
-    };
-    /**
-     */
-    formatValue(value: string): string;
-    /**
-     * Getting the readonly value, iso value converted for human reading
-     */
-    get readonlyvalue(): string;
-    /**
-     * Set mandatory status of attribute
-     */
-    set mandatory(mandatory: boolean);
-    /**
-     * Getting mandatory status of attribute
-     */
-    get mandatory(): boolean;
-    /**
-     */
-    get configuredMandatory(): boolean | null;
-    /**
-     */
-    set readonly(readonly: boolean);
-    /**
-     */
-    get readonly(): boolean;
-    /**
-     */
-    set disabled(disabled: boolean);
-    /**
-     */
-    get disabled(): boolean;
-    /**
-     */
-    set isResult(isResult: boolean);
-    /**
-     */
-    get isResult(): boolean;
-    /**
-     * Getting the display and input format of a attribute
-     */
-    get format(): string | null;
-    /**
-     */
-    get formatLabel(): string;
-    /**
-     * Get minimum string length
-     */
-    get minLength(): number | null;
-    /**
-     * Get maximum string length
-     */
-    get maxLength(): number | null;
-    /**
-     */
-    get operator(): string;
-    /**
-     * Get assistant message
-     */
-    get assistantMessage(): string | null;
-    /**
-     * Get valid status
-     */
-    get isValid(): boolean;
-    /**
-     * Retrieve applicable constraint for this attribute
-     */
-    get constraintCollection(): ConstraintCollection;
-    /**
-     * Template method for class extending this model to add extra constraints
-     * @abstract
-     */
-    addConstraints(): ConstraintCollection;
-    /**
-     * Used to programmatically overwrite the setting USE_CLIENTSIDE_VALIDATION
-     */
-    setUseClientsideValidation(enabled: boolean): void;
-    /**
-     * Indicates if client side validation is enabled
-     * @returns {boolean}
-     */
-    useClientsideValidation(): boolean;
-    /**
-     * Validate input on client side constraint
-     */
-    validate(value: string): boolean;
-    /**
-     * Indicates if attribute is optional and empty
-     */
-    isOptionalAndEmpty(value: string): boolean;
-    /**
-     * Retrieve error messages of this attribute
-     */
-    get errorCollection(): ErrorCollection;
-    /**
-     * Check if attribute is in error
-     */
-    inError(): boolean;
-    /**
-     * Reset static error messages on attribute
-     */
-    resetErrors(): void;
-    /**
-     * Registers an error that was received from a server response
-     */
-    addServerError(error: FormErrorAnchor): void;
-    /**
-     */
-    removeServerError(id: string): void;
-    /**
-     */
-    hasServerErrors(): boolean;
-    /**
-     */
-    hasErrors(): boolean;
-    /**
-     * Registers a missing error that was received from the server
-     */
-    addMissingError(receivedAttribute?: AttributeType): void;
-    /**
-     */
-    removeMissingError(): void;
-    /**
-     */
-    addServerConstraint(id: string, defaultMessage?: string, parameters?: MessageParameters): void;
-    /**
-     */
-    formatParameters(parameters: Object): {
-        [string]: string | number;
-    };
-    /**
-     */
-    get hasDynamicValidationData(): boolean;
-    /**
-     */
-    updateValidations(errors: Array<Object>): void;
-    /**
-     * Set last modification to current timestamp
-     */
-    updateLastModification(): void;
-    /**
-     * Inidicates if attribute is changed since a given timestamp (Date.now)
-     */
-    isChangedSince(timestamp: number): boolean;
-    /**
-     * Abstract reset method which should be implemented on each attribute that has this attribute as a base class.
-     *
-     * @abstract
-     */
-    reset(): void;
-    /**
-     * Merge old attribute with the attribute from the server.
-     * Readonly attributes always need to show the value from the server
-     */
-    mergeAttribute(oldAttribute: AttributeType): void;
-    /**
-     * Abstract update method which should be implemented on each attribute that has this attribute as a base class.
-     * @abstract
-     */
-    update(value: string, changedAttribute?: AttributeType): AttributeType;
-    /**
-     * Abstract updateByAttribute method which should be implemented on each attribute that has this attribute as a base class.
-     * @abstract
-     */
-    updateByAttribute(otherAttribute: AttributeType): void;
-    /**
-     * Indicate if attribute is editable
-     */
-    set isEditable(isEditable: boolean);
-    /**
-     * Retrieve if attribute is editable
-     */
-    get isEditable(): boolean;
-    /**
-     * Indicates if the attribute is visible
-     */
-    get isVisible(): boolean;
-    /**
-     */
-    set isHidden(isHidden: boolean);
-    /**
-     */
-    get isHidden(): boolean;
-    /**
-     * Explicitly toggle visibility of this attribute
-     */
-    show(): void;
-    /**
-     */
-    hide(): void;
-    /**
-     */
-    equals(otherAttribute: AttributeType): boolean;
-    /**
-     * Readonly attribute width indicates the proposed width of this attribute
-     */
-    get readonlyWidth(): $Keys<typeof ATTRIBUTE_WIDTH>;
-    /**
-     */
-    set layoutHintRules(rules: LayoutHintRuleCollection);
-    /**
-     */
-    get layoutHintRules(): LayoutHintRuleCollection;
-    /**
-     */
-    processLayoutHintRules(attributes: AttributeCollection): void;
-    /**
-     * Indicates if content comes from the data service
-     */
-    get hasContentFromData(): boolean;
-    /**
-     */
-    get content(): AttributeContent;
-}
-import BaseModel from "../base/BaseModel";
-import ErrorCollection from "../error/ErrorCollection";
-import ConstraintCollection from "./input-constraints/ConstraintCollection";
-import ConceptDetailModel from "../concepts/ConceptDetailModel";
-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 { AttributeType } from "../types";
-import { MessageParameters } from "../../i18n/types";
-import { ATTRIBUTE_WIDTH } from "../../constants/Constants";
-import AttributeCollection from "./AttributeCollection";
-import AttributeContent from "./AttributeContent";

package/esm/models/attributes/AttributeSetModel.d.ts

@@ -1,36 +0,0 @@
-/**
- */
-export default class AttributeSetModel extends BaseModel {
-    /**
-     */
-    constructor(key?: string, data?: Object, contributions?: Object, modelOptions?: ModelOptions);
-    _key: string;
-    _attributeCollection: AttributeCollection;
-    /**
-     */
-    set key(key: string);
-    /**
-     */
-    get key(): string;
-    /**
-     */
-    get label(): string | null;
-    /**
-     * Set the attributes with a new AttributeCollection
-     */
-    set attributeCollection(collection: AttributeCollection);
-    /**
-     * Retrieve attribute collection
-     */
-    get attributeCollection(): AttributeCollection;
-    /**
-     */
-    createChildAttributeSetModel(key: string, dataObject: Object, index?: number): AttributeSetModel;
-    /**
-     * Retrieve child {@code AttributeSetModel}s
-     */
-    getChildAttributeSets(): Array<AttributeSetModel>;
-}
-import BaseModel from "../base/BaseModel";
-import AttributeCollection from "./AttributeCollection";
-import { ModelOptions } from "../types";

package/esm/models/attributes/BooleanAttributeModel.d.ts

@@ -1,69 +0,0 @@
-/**
- * Model for a boolean attribute
- */
-export default class BooleanAttributeModel extends AttributeModel {
-    _referenceDate: string;
-    _options: ChoiceAttributeOptionCollection;
-    /**
-     * Set reference date for concepts and content
-     */
-    set referenceDate(date: string);
-    /**
-     * Retrieve reference date of attribute which can be used as entryDate for content
-     */
-    get referenceDate(): string;
-    /**
-     * Getting the type of choice filter. For instance checkbox, radiobutton, combobox.
-     */
-    get choicetype(): "checkbox" | "radiobutton" | "combobox" | "toggle";
-    /**
-     * Can multiple options be selected
-     */
-    get isMultiple(): boolean;
-    /**
-     * Check if options need to be rendered as tree
-     */
-    get isTree(): boolean;
-    /**
-     * Get content configuration configured on the attribute.
-     * Only applicable for taxonomy element and knowledge codemaps,
-     * content configuration for instrument questions is available on the form object
-     */
-    get contentConfiguration(): ContentConfigurationElements | null;
-    /**
-     * Retrieve available choice options
-     */
-    get options(): ChoiceAttributeOptionCollection;
-    /**
-     * Getting all enabled options
-     */
-    get selected(): Array<string>;
-    /**
-     * Retrieve list of selected options, joined with comma
-     */
-    getValue(): string | null;
-    /**
-     * Setting an option selected or unselected based on the current state
-     */
-    toggleOption(code: string): void;
-    /**
-     * Enable a option
-     */
-    enableOption(code: string): void;
-    /**
-     * Disable a option
-     */
-    disableOption(code: string): void;
-    /**
-     * Update attribute by name and value
-     */
-    update(value: any): BooleanAttributeModel;
-    /**
-     */
-    getFormData(): {
-        [string]: boolean | null;
-    } | null;
-}
-import AttributeModel from "./AttributeModel";
-import ChoiceAttributeOptionCollection from "./ChoiceAttributeOptionCollection";
-import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";

package/esm/models/attributes/CaptchaAttributeModel.d.ts

@@ -1,19 +0,0 @@
-/**
- * Password attribute
- */
-export default class CaptchaAttributeModel extends AttributeModel {
-    _answer: string;
-    /**
-     * Update the attribute by name and value
-     */
-    update(value: string): this;
-    /**
-     */
-    setAnswer(answer: string): void;
-    /**
-     * Retrieve the given answer for the captcha
-     * The value of this attribute is the token id of the captcha
-     */
-    getAnswer(): string;
-}
-import AttributeModel from "./AttributeModel";

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

@@ -1,85 +0,0 @@
-/**
- * Model for a choice attribute
- */
-export default class ChoiceAttributeModel extends AttributeModel {
-    _options: ChoiceAttributeOptionCollection;
-    /**
-     */
-    get optionType(): string;
-    /**
-     */
-    get isUser(): boolean;
-    /**
-     * Retrieve lookup service link
-     */
-    get lookupLink(): LinkModel | null;
-    /**
-     * Retrieve lookup service as list link
-     */
-    get lookupListLink(): LinkModel | null;
-    /**
-     */
-    get lookupListLabel(): string;
-    /**
-     * Retrieve available choice options
-     */
-    get options(): ChoiceAttributeOptionCollection;
-    /**
-     * Getting all enabled options
-     */
-    get selected(): Array<string>;
-    /**
-     * Retrieve list of selected options, joined with comma
-     */
-    getValue(): string | null;
-    /**
-     * Setting an option selected or unselected based on the current state
-     */
-    toggleOption(code: string): void;
-    /**
-     * Enable a option
-     */
-    enableOption(code: string): void;
-    /**
-     * Disable a option
-     */
-    disableOption(code: string): void;
-    /**
-     * Add a new option to the collection of lookup options
-     */
-    addOption(option: Object): void;
-    /**
-     * Getting the type of choice filter. For instance checkbox, radiobutton, combobox.
-     */
-    get choicetype(): "checkbox" | "radiobutton" | "combobox" | "list" | "listview" | "table" | "longlist" | "toggle";
-    /**
-     * Can multiple options be selected
-     */
-    get isMultiple(): boolean;
-    /**
-     * 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
-     */
-    update(value: any): ChoiceAttributeModel;
-    /**
-     * Get content configuration configured on the attribute.
-     * Only applicable for taxonomy element and knowledge codemaps,
-     * content configuration for instrument questions is available on the form object
-     */
-    get contentConfiguration(): ContentConfigurationElements | null;
-    /**
-     * Get placeholder text
-     */
-    get placeholder(): string;
-}
-import AttributeModel from "./AttributeModel";
-import ChoiceAttributeOptionCollection from "./ChoiceAttributeOptionCollection";
-import LinkModel from "../links/LinkModel";
-import { AttributeType } from "../types";
-import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";

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

@@ -1,87 +0,0 @@
-export default ChoiceAttributeOptionCollection;
-/**
- */
-declare class ChoiceAttributeOptionCollection extends ResourceCollection<ChoiceAttributeOptionModel, any> {
-    /**
-     */
-    static create(data?: Object, contributions?: Object, modelOptions?: ChoiceAttributeOptionModelOptions): ChoiceAttributeOptionCollection;
-    constructor(modelOptions?: ChoiceAttributeOptionModelOptions);
-    _modelOptions: ChoiceAttributeOptionModelOptions;
-    _headers: Array<ListHeaderModel>;
-    _sortOptions: boolean;
-    /**
-     */
-    set sortOptions(sortOptions: boolean);
-    /**
-     */
-    get sortOptions(): boolean;
-    /**
-     */
-    getSelectedOptions(data: Object): Array<string>;
-    /**
-     */
-    getOptionCount(code: string, options: Array<Object>): number | null;
-    /**
-     */
-    addOptions(data: Object, contributions: Object): ChoiceAttributeOptionCollection;
-    /**
-     * Create options based on data and dynamischema
-     */
-    addDynamicSchema(data: Object, contributions: Object): ChoiceAttributeOptionCollection;
-    /**
-     */
-    addBooleanOption(code: "true" | "false", defaultLabel: string, data: string | Array<string>, options?: Array<Object>): void;
-    /**
-     * Create two static options for true and false,
-     * there might be alternative labels configured for each option value
-     */
-    addBooleanOptions(value: any, contributions: Object): ChoiceAttributeOptionCollection;
-    /**
-     */
-    addOption(data: string | Array<string>, contributions: Object): ChoiceAttributeOptionCollection;
-    /**
-     */
-    getOptionByCode(code: string): ChoiceAttributeOptionModel | void;
-    /**
-     */
-    hasOptionByCode(code: string): boolean;
-    /**
-     * Get all options that have selected property true
-     */
-    get selected(): Array<ChoiceAttributeOptionModel>;
-    /**
-     * Deselect all options
-     */
-    deselectAll(): void;
-    /**
-     * Select an option by it's code
-     */
-    select(optionCode: string): void;
-    /**
-     * Deselect an option by it's code
-     */
-    deselect(optionCode: string): void;
-    /**
-     * Toggle an option by it's code
-     */
-    toggle(optionCode: string, action: "select" | "deselect"): void;
-    /**
-     */
-    setReferenceDate(date: ISO_DATE): Array<ChoiceAttributeOptionModel>;
-    /**
-     */
-    set referenceDate(date: ISO_DATE);
-    /**
-     */
-    addHeaders(headers: Array<Object>): void;
-    /**
-     */
-    get headers(): Array<ListHeaderModel>;
-    /**
-     */
-    mergeOptions(withOptions: ChoiceAttributeOptionCollection, addNotExistingOptions?: boolean, removeNotExistingOptions?: boolean): void;
-}
-import ChoiceAttributeOptionModel from "./ChoiceAttributeOptionModel";
-import ResourceCollection from "../base/ResourceCollection";
-import { ChoiceAttributeOptionModelOptions } from "./ChoiceAttributeOptionModel";
-import ListHeaderModel from "../list/ListHeaderModel";