@beinformed/ui 1.24.1-beta.1 → 1.24.1-beta.4

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

@@ -0,0 +1,395 @@
+/**
+ * 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>): void;
+    /**
+     * Set the concept
+     */
+    set concept(arg: ConceptDetailModel);
+    /**
+     * Get concept information
+     */
+    get concept(): ConceptDetailModel;
+    /**
+     * Getting the attribute key
+     */
+    get key(): string;
+    /**
+     */
+    set parentKey(arg: 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(arg: string);
+    /**
+     * Getting the label of the attribute
+     */
+    get label(): string;
+    /**
+     */
+    set hasContentConfiguration(arg: 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(): "center" | "left" | "right";
+    /**
+     * Handles layout hint align-left, align-center and align-right
+     */
+    get alignment(): "center" | "left" | "right";
+    /**
+     * Retrieve links of attribute
+     */
+    get links(): LinkCollection;
+    /**
+     * Retrieve link of attribute when available
+     */
+    get downloadLink(): LinkModel;
+    /**
+     * Retrieve concept link of attribute when available
+     */
+    get conceptLink(): LinkModel;
+    /**
+     * Set reference date for concepts and content
+     */
+    set referenceDate(arg: 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(arg: 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(arg: any);
+    /**
+     * 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(): {};
+    /**
+     */
+    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(arg: boolean);
+    /**
+     * Getting mandatory status of attribute
+     */
+    get mandatory(): boolean;
+    /**
+     */
+    get configuredMandatory(): boolean;
+    /**
+     */
+    set readonly(arg: boolean);
+    /**
+     */
+    get readonly(): boolean;
+    /**
+     */
+    set disabled(arg: boolean);
+    /**
+     */
+    get disabled(): boolean;
+    /**
+     */
+    set isResult(arg: boolean);
+    /**
+     */
+    get isResult(): boolean;
+    /**
+     * Getting the display and input format of a attribute
+     */
+    get format(): string;
+    /**
+     */
+    get formatLabel(): string;
+    /**
+     * Get minimum string length
+     */
+    get minLength(): number;
+    /**
+     * Get maximum string length
+     */
+    get maxLength(): number;
+    /**
+     */
+    get operator(): string;
+    /**
+     * Get assistant message
+     */
+    get assistantMessage(): string;
+    /**
+     * 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(): 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;
+    /**
+     * Indicate if attribute is editable
+     */
+    set isEditable(arg: boolean);
+    /**
+     * Retrieve if attribute is editable
+     */
+    get isEditable(): boolean;
+    /**
+     * Indicates if the attribute is visible
+     */
+    get isVisible(): boolean;
+    /**
+     */
+    set isHidden(arg: 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<{
+        EXTRA_SMALL: string;
+        SMALL: string;
+        MEDIUM: string;
+        LARGE: string;
+        EXTRA_LARGE: string;
+    }>;
+    /**
+     */
+    set layoutHintRules(arg: 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 ContentConfiguration from "../contentconfiguration/ContentConfiguration";
+import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";
+import { FormErrorAnchor } from "../types";
+import { MessageParameters } from "../../i18n/types";
+import { AttributeType } from "../types";
+import AttributeCollection from "./AttributeCollection";
+import AttributeContent from "./AttributeContent";

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

@@ -0,0 +1,28 @@
+/**
+ */
+export default class AttributeSetModel extends BaseModel {
+    /**
+     */
+    constructor(key?: string, data?: Object, contributions?: Object);
+    _key: string;
+    _attributeCollection: AttributeCollection;
+    /**
+     */
+    set key(arg: string);
+    /**
+     */
+    get key(): string;
+    /**
+     */
+    get label(): string;
+    /**
+     * Set the attributes with a new AttributeCollection
+     */
+    set attributeCollection(arg: AttributeCollection);
+    /**
+     * Retrieve attribute collection
+     */
+    get attributeCollection(): AttributeCollection;
+}
+import BaseModel from "../base/BaseModel";
+import AttributeCollection from "./AttributeCollection";

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

@@ -0,0 +1,65 @@
+/**
+ * Model for a boolean attribute
+ */
+export default class BooleanAttributeModel extends AttributeModel {
+    _referenceDate: string;
+    _options: ChoiceAttributeOptionCollection;
+    /**
+     * Set reference date for concepts and content
+     */
+    set referenceDate(arg: 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(): "toggle" | "checkbox" | "radiobutton" | "combobox";
+    /**
+     * 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;
+    /**
+     * Retrieve available choice options
+     */
+    get options(): ChoiceAttributeOptionCollection;
+    /**
+     * Getting all enabled options
+     */
+    get selected(): 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;
+    concept: any;
+    /**
+     * Update attribute by name and value
+     */
+    update(value: any): BooleanAttributeModel;
+}
+import AttributeModel from "./AttributeModel";
+import ChoiceAttributeOptionCollection from "./ChoiceAttributeOptionCollection";
+import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";

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

@@ -0,0 +1,10 @@
+/**
+ * Password attribute
+ */
+export default class CaptchaAttributeModel extends AttributeModel {
+    /**
+     * Update the attribute by name and value
+     */
+    update(value: string): this;
+}
+import AttributeModel from "./AttributeModel";

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

@@ -0,0 +1,76 @@
+/**
+ * Model for a choice attribute
+ */
+export default class ChoiceAttributeModel extends AttributeModel {
+    _options: ChoiceAttributeOptionCollection;
+    concept: any;
+    /**
+     * Retrieve lookup service link
+     */
+    get lookupLink(): LinkModel;
+    /**
+     * Retrieve lookup service as list link
+     */
+    get lookupListLink(): LinkModel;
+    /**
+     */
+    get lookupListLabel(): string;
+    /**
+     * Retrieve available choice options
+     */
+    get options(): ChoiceAttributeOptionCollection;
+    /**
+     * Getting all enabled options
+     */
+    get selected(): 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(): "toggle" | "table" | "list" | "checkbox" | "radiobutton" | "combobox" | "listview" | "longlist";
+    /**
+     * Can multiple options be selected
+     */
+    get isMultiple(): boolean;
+    /**
+     * Check if options need to be rendered as tree
+     */
+    get isTree(): boolean;
+    /**
+     * 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;
+    /**
+     * Get placeholder text
+     */
+    get placeholder(): string;
+}
+import AttributeModel from "./AttributeModel";
+import ChoiceAttributeOptionCollection from "./ChoiceAttributeOptionCollection";
+import LinkModel from "../links/LinkModel";
+import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";

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

@@ -0,0 +1,82 @@
+export default ChoiceAttributeOptionCollection;
+/**
+ */
+declare class ChoiceAttributeOptionCollection extends ResourceCollection<ChoiceAttributeOptionModel, any> {
+    /**
+     */
+    static create(data?: Object, contributions?: Object, referenceDate?: ISO_DATE): ChoiceAttributeOptionCollection;
+    constructor(initCollection?: ChoiceAttributeOptionModel[]);
+    _headers: Array<ListHeaderModel>;
+    _sortOptions: boolean;
+    /**
+     */
+    set sortOptions(arg: boolean);
+    /**
+     */
+    get sortOptions(): boolean;
+    /**
+     */
+    getSelectedOptions(data: Object): Array<string>;
+    /**
+     */
+    getOptionCount(code: string, options: Array<Object>): number | null;
+    /**
+     */
+    addOptions(data: Object, contributions: Object, referenceDate?: ISO_DATE): ChoiceAttributeOptionCollection;
+    /**
+     * Create options based on data and dynamischema
+     */
+    addDynamicSchema(data: Object, contributions: Object, referenceDate?: ISO_DATE): ChoiceAttributeOptionCollection;
+    /**
+     */
+    addBooleanOption(code: "true" | "false", defaultLabel: string, data: string | Array<string>, options?: Array<Object>): void;
+    /**
+     */
+    getDefaultValueForOption(value: any, contributions: Object): string;
+    /**
+     * 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, referenceDate?: ISO_DATE): ChoiceAttributeOptionCollection;
+    /**
+     * Get all options that have selected property true
+     */
+    get selected(): 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(arg: ISO_DATE);
+    /**
+     */
+    addHeaders(headers: Array<Object>): void;
+    /**
+     */
+    get headers(): ListHeaderModel[];
+    /**
+     */
+    mergeOptions(withOptions: ChoiceAttributeOptionCollection, addNotExistingOptions?: boolean): void;
+}
+import ChoiceAttributeOptionModel from "./ChoiceAttributeOptionModel";
+import ResourceCollection from "../base/ResourceCollection";
+import ListHeaderModel from "../list/ListHeaderModel";