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

package/types/models/actions/ActionModel.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Defines an Action. For instance an action on the tab 'books', which leads to a form
+ */
+export default class ActionModel extends BaseModel {
+    /**
+     */
+    static createFromHref(name: string, href: string, label: string, type?: string): ActionModel;
+    _fieldCollection: AttributeCollection;
+    _href: Href;
+    _icon: string;
+    /**
+     */
+    get isDisabled(): boolean;
+    /**
+     */
+    set selfhref(arg: Href);
+    /**
+     * retrieve href of action
+     */
+    get selfhref(): Href;
+    /**
+     * retrieve request method
+     */
+    get method(): $Keys<{
+        POST: string;
+        GET: string;
+    }>;
+    /**
+     * Retrieve type of method
+     */
+    get type(): string;
+    /**
+     * Retrieve name of action
+     */
+    get name(): string;
+    /**
+     * retrieve the collection of field attributes as an array
+     */
+    get fields(): AttributeType[];
+    /**
+     */
+    set fieldCollection(arg: AttributeCollection);
+    /**
+     * Retrieve the field collection
+     */
+    get fieldCollection(): AttributeCollection;
+    /**
+     * Retrieve querystring of action
+     */
+    get querystring(): string;
+    /**
+     * Retrieve a field by it's key
+     */
+    getFieldByKey(key: string): AttributeType | null;
+    /**
+     * Indicates if field exists by the given key
+     */
+    hasFieldByKey(key: string): boolean;
+    /**
+     * Getting the key/name of this action
+     */
+    get key(): string;
+    /**
+     * Getting the label of the action
+     */
+    get label(): string;
+    /**
+     */
+    get isProcessTask(): boolean;
+    /**
+     */
+    get processStatus(): ProcessStatusSettingsModel;
+    /**
+     */
+    set icon(arg: string);
+    /**
+     */
+    get icon(): string;
+}
+import BaseModel from "../base/BaseModel";
+import AttributeCollection from "../attributes/AttributeCollection";
+import Href from "../href/Href";
+import { AttributeType } from "../types";
+import ProcessStatusSettingsModel from "../process/ProcessStatusSettingsModel";

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

@@ -0,0 +1,41 @@
+/**
+ * The Application model
+ */
+export default class ApplicationModel extends ResourceModel {
+    _userServices: UserServicesModel | null;
+    /**
+     * Set the userservices for this application
+     */
+    set userServices(arg: UserServicesModel);
+    /**
+     * returns the userservices configured for this application
+     */
+    get userServices(): UserServicesModel;
+    /**
+     * Getting the authentication types of the application
+     */
+    get authenticationTypes(): AuthenticationType[];
+    /**
+     * Getting the tab links
+     */
+    get tabs(): LinkCollection;
+    /**
+     * Get modelcatalog link
+     */
+    get modelcatalog(): LinkModel;
+    /**
+     * Indicates if the user is logged in
+     */
+    get isLoggedIn(): boolean;
+    /**
+     * Retrieve link to the user information,
+     * only available when the user services are available
+     */
+    get userHref(): Href;
+}
+import ResourceModel from "../base/ResourceModel";
+import UserServicesModel from "../user/UserServicesModel";
+import { AuthenticationType } from "../types";
+import LinkCollection from "../links/LinkCollection";
+import LinkModel from "../links/LinkModel";
+import Href from "../href/Href";

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

@@ -0,0 +1,96 @@
+export default AttributeCollection;
+/**
+ * Collection of attributes
+ */
+declare class AttributeCollection extends ResourceCollection<AttributeType, any> {
+    constructor(data?: Object | Array<Object>, contributions?: Array<Object>, isReadonly?: boolean);
+    /**
+     * Replace attributes with a new array of attributes
+     */
+    set attributes(arg: AttributeType[]);
+    /**
+     * Retrieve all attributes in this collection<br>
+     * This getter processes layout hints, this is different from the standard {@link BaseCollection#all} property
+     * @returns {Array<AttributeType>}
+     */
+    get attributes(): AttributeType[];
+    /**
+     */
+    processLayoutHintRules(): void;
+    /**
+     * Retrieve only visible attributes from the collection
+     */
+    get visible(): AttributeType[];
+    /**
+     */
+    get questions(): AttributeType[];
+    /**
+     */
+    get results(): AttributeType[];
+    /**
+     */
+    getAttributeByAttribute(attribute: AttributeType): AttributeType | null;
+    /**
+     * Get a single attribute by it's key
+     */
+    getAttributeByKey(key: string): AttributeType | null;
+    /**
+     * Indicates if attribute with key exists in collection
+     */
+    hasAttributeByKey(key: string): boolean;
+    /**
+     * Getting the first attribute having the supplied layout hint
+     */
+    getAttributeByLayoutHint(...hints: Array<string>): AttributeType | null;
+    /**
+     * Getting a choice attribute by layouthint, returns null when not found or not a choice attribute
+     */
+    getChoiceAttributeByLayoutHint(layoutHint: string): ChoiceAttributeModel | null;
+    /**
+     * Getting all attributes having the supplied layout hint
+     */
+    getAttributesByLayoutHint(...hints: Array<string>): Array<AttributeType>;
+    /**
+     * Replace an attribute instance in the collection with a new attribute instance
+     */
+    replace(oldAttribute: AttributeType, newAttribute: AttributeType): void;
+    /**
+     * Replace an attribute by the key of the attribute
+     */
+    replaceByKey(key: string, newAttribute: AttributeType): void;
+    /**
+     * Set reference date by replacing an old attribute with a new attribute with a reference Date
+     * Date is a string in ISO format yyyy-MM-dd
+     */
+    setReferenceDate(date: string): void;
+    /**
+     */
+    hasServerErrors(): boolean;
+    /**
+     */
+    addServerError(error: FormErrorAnchor): void;
+    /**
+     */
+    hasErrors(): boolean;
+    /**
+     */
+    updateValidations(errors: Array<Object>): AttributeCollection;
+    /**
+     */
+    indicateContentConfiguration(contentConfiguration: ContentConfiguration): void;
+    /**
+     * Generate formdata object for current collection based on formdata of attributes
+     * Skip attributes that are readonly, the confirmation password or null
+     */
+    get formdata(): {};
+    /**
+     */
+    getFormData(validationData?: boolean): {
+        [string]: any;
+    } | null;
+}
+import { AttributeType } from "../types";
+import ResourceCollection from "../base/ResourceCollection";
+import ChoiceAttributeModel from "./ChoiceAttributeModel";
+import { FormErrorAnchor } from "../types";
+import ContentConfiguration from "../contentconfiguration/ContentConfiguration";

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

@@ -0,0 +1,64 @@
+export default AttributeContent;
+/**
+ */
+declare class AttributeContent {
+    constructor(content: ContentData | null);
+    _content: ContentData | null;
+    /**
+     */
+    get fromData(): boolean;
+    /**
+     */
+    get header(): {
+        label: string | null;
+        description: string | null;
+    };
+    /**
+     */
+    get elements(): ContentAll;
+    /**
+     */
+    get label(): string;
+    /**
+     */
+    getContentElements<T>(elementName: string): T[];
+    /**
+     */
+    getContentElementCollections<T_1>(elementName: string, collectionName: string): T_1[];
+    /**
+     */
+    getContentElementCollectionByLabels<T_2, U>(elementName: string, collectionName: string, labels: Array<string>): U[];
+    /**
+     */
+    get properties(): PropertyData[];
+    /**
+     * Get concept properties by property element label
+     */
+    getConceptPropertiesByLabels(labels: Array<string>): Array<PropertyData>;
+    /**
+     */
+    get textfragments(): TextFragmentData[];
+    /**
+     * Get concept text fragments by text fragment element label
+     */
+    getTextFragmentsByLabels(labels: Array<string>): Array<TextFragmentData>;
+    /**
+     */
+    get sections(): SectionModel[];
+    /**
+     */
+    getSectionsByType(types: Array<string>): Array<SectionModel>;
+    /**
+     * Get concept text fragments by text fragment element label
+     */
+    getSectionsByLabels(labels: Array<string>): Array<SectionModel>;
+    /**
+     */
+    getReferredSections(): Array<SectionModel | SubSectionModel>;
+}
+import { ContentData } from "../types";
+import { ContentAll } from "../types";
+import { PropertyData } from "../types";
+import { TextFragmentData } from "../types";
+import SectionModel from "../content/SectionModel";
+import SubSectionModel from "../content/SubSectionModel";

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

@@ -0,0 +1,67 @@
+export default AttributeDataHelper;
+/**
+ * This util helps to normalize various attribute data formats available in the modular ui.
+ * It fixes differences in choice attributes with dynamic schema's, links on download attributes, composites with various children, etc
+ *
+ * @private
+ */
+declare class AttributeDataHelper {
+    /**
+     */
+    constructor(data: Object | Array<Object>, key: string, childrenKeys: Array<Object>);
+    _key: string;
+    _attribute: Object;
+    _value: any;
+    _children: Array<AttributeDataHelper>;
+    /**
+     */
+    childData(data: Object | Array<Object>, parentKey: string, childKey: string): Object;
+    /**
+     */
+    createChild(data: Object | Array<Object>, childData: Object, keyObject: Object): AttributeDataHelper;
+    /**
+     */
+    createChildren(data: Object | Array<Object>, childrenKeys?: Array<Object>): Array<AttributeDataHelper>;
+    /**
+     */
+    getValue(attribute: Object): any;
+    /**
+     */
+    get key(): string;
+    /**
+     */
+    get value(): any;
+    /**
+     */
+    get static(): boolean;
+    /**
+     */
+    get links(): any;
+    /**
+     */
+    get dynamicschemaId(): string;
+    /**
+     */
+    get dynamicschema(): any;
+    /**
+     */
+    get options(): any;
+    /**
+     */
+    get message(): any;
+    /**
+     */
+    get isResult(): boolean;
+    /**
+     */
+    get referenceDate(): any;
+    /**
+     */
+    get children(): AttributeDataHelper[];
+    /**
+     */
+    get content(): Object;
+    /**
+     */
+    getData(): Object;
+}