@beinformed/ui 1.62.8 → 1.63.0

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

@@ -1,350 +0,0 @@
-export default FormModel;
-/**
- */
-declare class FormModel extends ResourceModel {
-    /**
-     */
-    constructor(modularuiResponse: ModularUIResponse);
-    _lastUpdate: number;
-    _completedFormObjects: Array<FormObjectModel>;
-    _currentFormObject: FormObjectModel | null;
-    _previouslyEnteredFormObjects: Array<FormObjectModel>;
-    _mergePreviouslyEnteredObjects: boolean;
-    _endResultFormObjects: Array<FormObjectModel>;
-    _previousEndResultKeys: Array<string>;
-    _useClientsideValidation: boolean;
-    _errorCollection: ErrorCollection;
-    _redirectLocation: Href;
-    _commit: boolean;
-    _isFinished: boolean;
-    _isComplete: boolean;
-    _success: {
-        redirect: string;
-        data: Object;
-    } | null;
-    _parameters: Array<Parameter>;
-    _tokens: Array<string>;
-    /**
-     */
-    set lastUpdate(lastUpdate: number);
-    /**
-     */
-    get lastUpdate(): number;
-    /**
-     */
-    set currentFormObject(formObject: FormObjectModel | null);
-    /**
-     */
-    get currentFormObject(): FormObjectModel | null;
-    /**
-     */
-    set endResultFormObjects(endResultFormObjects: Array<FormObjectModel>);
-    /**
-     */
-    get endResultFormObjects(): Array<FormObjectModel>;
-    /**
-     */
-    set parameters(parameters: Array<Parameter>);
-    /**
-     */
-    get parameters(): Array<Parameter>;
-    /**
-     */
-    set isComplete(isComplete: boolean);
-    /**
-     * Indicates if form is completely entered
-     */
-    get isComplete(): boolean;
-    /**
-     */
-    get actiontype(): string;
-    /**
-     * Get form level button labels
-     */
-    get buttonLabels(): Object;
-    /**
-     * @returns button label from contributions;
-     */
-    getButtonLabel(buttonType: "cancel" | "previous" | "next" | "finish"): string | null;
-    /**
-     * Get all applicable objects
-     */
-    get allObjects(): Array<FormObjectModel>;
-    /**
-     */
-    get objectKeys(): Array<string>;
-    /**
-     */
-    get numberOfExpectedQuestions(): number;
-    /**
-     * Has questions configured on form
-     */
-    get hasNoQuestionsConfigured(): boolean;
-    /**
-     */
-    addGlobalDynamicSchema(anchor: Object, dynamicschema: Object): Object;
-    /**
-     */
-    getMissingAnchors(): Array<Object>;
-    /**
-     * Create form object based on the data and contributions available in this form
-     */
-    createFormObject(): FormObjectModel | null;
-    /**
-     */
-    addEmptyFormObject(formObjectModel?: FormObjectModel | null): void;
-    /**
-     */
-    getHighestRepeatIndex(formObjectModel: FormObjectModel): number;
-    /**
-     */
-    addFormObject(formObjectModel: FormObjectModel): void;
-    /**
-     */
-    set completedFormObjects(formObjects: Array<FormObjectModel>);
-    /**
-     * Completed objects are previously entered questions
-     */
-    get completedFormObjects(): Array<FormObjectModel>;
-    /**
-     * Retrieve a form object by the key
-     */
-    getFormObjectByKey(key: string): FormObjectModel | null;
-    /**
-     * Retrieve a form object by a layouthint
-     */
-    getFormObjectByLayoutHint(hint: string): FormObjectModel | null;
-    /**
-     */
-    removeFormObject(formObjectModel: FormObjectModel | null): void;
-    /**
-     */
-    set previouslyEnteredFormObjects(formObjects: Array<FormObjectModel>);
-    /**
-     * Previously entered objects are questions that have been entered before,
-     * but are currently not applicable for the form.
-     * For example because of previous navigation
-     */
-    get previouslyEnteredFormObjects(): Array<FormObjectModel>;
-    /**
-     * Handle end results
-     */
-    setEndResultFormObjects(): Array<FormObjectModel>;
-    /**
-     */
-    get expectsEndResultFormObjects(): boolean;
-    /**
-     */
-    getEndResultFormObjects(): Array<FormObjectModel>;
-    /**
-     */
-    set previousEndResultKeys(endResultFormObjectKeys: Array<string>);
-    /**
-     */
-    get previousEndResultKeys(): Array<string>;
-    /**
-     * Error handling
-     */
-    get isValid(): boolean;
-    /**
-     */
-    hasServerErrors(): boolean;
-    /**
-     */
-    hasErrors(): boolean;
-    /**
-     * Add an error to the error collection of this form
-     */
-    addServerError(error: ErrorResponse): void;
-    /**
-     * Reset error messages
-     */
-    resetErrors(): void;
-    /**
-     */
-    set errorCollection(errorCollection: ErrorCollection);
-    /**
-     */
-    get errorCollection(): ErrorCollection;
-    /**
-     */
-    set commit(commit: boolean);
-    /**
-     * Indicates if the form needs to be committed
-     */
-    get commit(): boolean;
-    /**
-     */
-    set isFinished(isFinished: boolean);
-    /**
-     * Inidicates if form is finished: Form is completely entered and committed
-     */
-    get isFinished(): boolean;
-    /**
-     * Handle success redirects
-     */
-    get successRedirect(): Href | null;
-    /**
-     */
-    get redirectLocation(): Href;
-    /**
-     * Get the result data as plain json object
-     */
-    getSuccessData(): Object | null;
-    /**
-     * Retrieve an object where each property is a result data attribute set
-     */
-    getResultData(): {
-        [key: string]: AttributeSetModel;
-    } | null;
-    /**
-     */
-    get resultData(): Object | null;
-    /**
-     * Href handling
-     */
-    setParameters(modularuiResponse: ModularUIResponse): Array<Parameter>;
-    /**
-     */
-    selfhrefNoCommitParam(): Href;
-    /**
-     */
-    selfhrefWithCommitParam(): Href;
-    /**
-     * Replaces all tokens with the given collection of tokens
-     */
-    set tokens(tokens: Array<string>);
-    /**
-     * Handle form tokens to indicate concurrent form use
-     */
-    get tokens(): Array<string>;
-    /**
-     * Removes all tokens from the form
-     */
-    removeTokens(): void;
-    /**
-     * Keep track of changed form
-     */
-    isChanged(): boolean;
-    /**
-     */
-    getFormDataObjects(validOnly?: boolean, validationData?: boolean): Array<Object>;
-    /**
-     */
-    getFormData(validOnly?: boolean, withConcurrencyToken?: boolean, validationData?: boolean): string;
-    /**
-     * Used to programmatically overwrite the setting USE_CLIENTSIDE_VALIDATION
-     */
-    setUseClientsideValidation(enabled: boolean): void;
-    /**
-     * Indicates if client side validation is enabled
-     * @returns {boolean}
-     */
-    useClientsideValidation(): boolean;
-    /**
-     * Get form data for submitting
-     */
-    get formdata(): string;
-    /**
-     */
-    get validationData(): string;
-    /**
-     * Form navigation: Go one object back (previous button)
-     */
-    get hasPreviousStep(): boolean;
-    /**
-     * Go one form-object back,
-     * for repeating object this means go back
-     * until we get at a form object that had
-     * a different key than the current form object
-     */
-    setPreviousObject(): void;
-    /**
-     * Set success information, contains redirect and event data
-     * @param success
-     */
-    set success(success: {
-        redirect: string;
-        data: Object;
-    } | null);
-    /**
-     * Retrieve success information from response
-     * @returns {{redirect: string, data: object}}
-     */
-    get success(): {
-        redirect: string;
-        data: Object;
-    } | null;
-    /**
-     * Form navigation: has next step or is last
-     */
-    get hasNextStep(): boolean;
-    /**
-     * 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;
-    /**
-     */
-    createSuccess(): void;
-    /**
-     * Process finished form
-     */
-    handleFinished(receivedForm: FormModel): void;
-    /**
-     */
-    handleRootErrors(errors: Array<Object>): void;
-    /**
-     * Process errors from received form
-     */
-    handleErrors(receivedForm: FormModel): void;
-    /**
-     * Process missing from received form
-     */
-    handleMissing(receivedForm: FormModel): void;
-    /**
-     * Received missing anchors in the response with an object id that is the current form object
-     */
-    processMissingErrors(receivedForm: FormModel): FormObjectModel | null;
-    /**
-     */
-    handleMissingErrors(receivedForm: FormModel): void;
-    /**
-     */
-    handleNewFormObject(receivedForm: FormModel): void;
-    /**
-     */
-    set mergePreviouslyEnteredObjects(mergePreviouslyEnteredObjects: boolean);
-    /**
-     * Indicate if a new form object model should be merged with a previousled entered form object model
-     * Set this property to false on the form that receives the new form to skip the merge behavior
-     */
-    get mergePreviouslyEnteredObjects(): boolean;
-    /**
-     */
-    handlePreviouslyEnteredFormObjects(receivedCurrentFormObject: FormObjectModel, previouslyEnteredFormObjects: Array<FormObjectModel>): void;
-    /**
-     */
-    mergeObjects(newObject: FormObjectModel, oldObject: FormObjectModel): FormObjectModel;
-    /**
-     */
-    findAttribute(findMethod: Function): AttributeType | null;
-}
-import ResourceModel from "../base/ResourceModel";
-import FormObjectModel from "./FormObjectModel";
-import ErrorCollection from "../error/ErrorCollection";
-import Href from "../href/Href";
-import Parameter from "../parameter/Parameter";
-import ErrorResponse from "../error/ErrorResponse";
-import AttributeSetModel from "../attributes/AttributeSetModel";
-import { ModularUIResponse } from "../../modularui";
-import { ModularUIModel } from "../types";
-import { AttributeType } from "../types";

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

@@ -1,210 +0,0 @@
-/**
- * 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<ErrorObject>): 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;
-            };
-        }>;
-    }, errors: Array<ErrorObject>): 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";
-type ErrorObject = {
-    anchor: {
-        objectid: string;
-        elementid?: string | undefined;
-    };
-    id: string;
-    message: string;
-    properties: MessageParameters;
-    layouthint: string[];
-};
-export {};

package/esm/models/grouping/GroupingModel.d.ts

@@ -1,86 +0,0 @@
-/**
- * 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 {};