@beinformed/ui 1.59.21 → 1.59.23

package/esm/models/links/LinkModel.d.ts

@@ -0,0 +1,93 @@
+export default LinkModel;
+/**
+ * Defines a Link. For instance below example of a link to the tab 'books'
+ * <br/>
+ * "Books": {
+ * "href": "/books",
+ * "profile": "/profiles/tab"
+ * }
+ */
+declare class LinkModel extends BaseModel {
+    /**
+     * Create a simple Link Model
+     */
+    static create(name: string, href: string | Href, label: string, modelOptions?: ModelOptions): LinkModel;
+    _href: Href;
+    _isCacheable: boolean;
+    _icon: string;
+    _targetModel: Class<ModularUIModel> | null;
+    /**
+     */
+    createHref(modelOptions: ModelOptions | null): void;
+    /**
+     * Set the href of the Link
+     */
+    set href(href: Href);
+    /**
+     * Retrieve the href of the link
+     */
+    get href(): Href;
+    /**
+     * Handle initial filter hints
+     * @param href
+     */
+    handleInitialFilters(href: Href): void;
+    /**
+     * Getting link group
+     */
+    get group(): string;
+    /**
+     * Getting the key/name of this link
+     */
+    get key(): string;
+    /**
+     * Getting the label of the link
+     */
+    get label(): string;
+    /**
+     * Getting the type of the link
+     */
+    get resourcetype(): string;
+    /**
+     */
+    get links(): LinkCollection;
+    /**
+     * Check if the href startswith the URI of the given href
+     */
+    isActive(link: LinkModel | null): boolean;
+    /**
+     * Setter for icon of LinkModel
+     */
+    set icon(icon: string);
+    /**
+     * Retrieve icon of LinkModel
+     */
+    get icon(): string;
+    /**
+     */
+    set targetModel(targetModel: Class<ModularUIModel>);
+    /**
+     */
+    get targetModel(): Class<ModularUIModel> | null;
+    /**
+     */
+    set isCacheable(isCacheable: boolean);
+    /**
+     */
+    get isCacheable(): boolean;
+    /**
+     */
+    get filterName(): string;
+    /**
+     */
+    get hasProcessStatusSettings(): boolean;
+    /**
+     */
+    get processStatus(): ProcessStatusSettingsModel | null;
+}
+import BaseModel from "../base/BaseModel";
+import Href from "../href/Href";
+import { ModularUIModel } from "../types";
+import { ModelOptions } from "../types";
+import LinkCollection from "../links/LinkCollection";
+import ProcessStatusSettingsModel from "../process/ProcessStatusSettingsModel";

package/esm/models/list/ListDetailModel.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Detail of a list item
+ */
+export default class ListDetailModel extends DetailModel {
+    _contentConfiguration: ContentConfiguration;
+    _listitem: ListItemModel;
+    _givenAnswers: CompositeAttributeModel | null;
+    _results: CompositeAttributeModel | null;
+    _eventdata: Array<AttributeSetModel>;
+    /**
+     * Set listitem of this listdetail and transfer listitem actions to listdetail actions
+     */
+    set listitem(listitem: ListItemModel);
+    /**
+     * Get listitem
+     */
+    get listitem(): ListItemModel;
+    /**
+     * Getting panel links
+     */
+    get panelLinks(): LinkCollection;
+    /**
+     */
+    set contentConfiguration(configuration: ContentConfiguration);
+    /**
+     * Getting the contentConfiguration
+     */
+    get contentConfiguration(): ContentConfiguration;
+    /**
+     * Getting the introduction text configured on the case view
+     */
+    get introtext(): string;
+    /**
+     */
+    setResultSection(): void;
+    /**
+     */
+    setResults(): void;
+    /**
+     */
+    setGivenAnswers(): void;
+    /**
+     */
+    get givenAnswers(): CompositeAttributeModel | null;
+    /**
+     */
+    get hasResults(): boolean;
+    /**
+     */
+    get results(): CompositeAttributeModel | null;
+    /**
+     */
+    get hasEventData(): boolean;
+    /**
+     */
+    addAttributes(key: string, eventData: Object, eventContributions: Object): void;
+    /**
+     */
+    setEventData(): void;
+    /**
+     */
+    get eventdata(): Array<AttributeSetModel>;
+}
+import DetailModel from "../detail/DetailModel";
+import ContentConfiguration from "../contentconfiguration/ContentConfiguration";
+import ListItemModel from "../list/ListItemModel";
+import CompositeAttributeModel from "../attributes/CompositeAttributeModel";
+import AttributeSetModel from "../attributes/AttributeSetModel";
+import LinkCollection from "../links/LinkCollection";

package/esm/models/list/ListHeaderModel.d.ts

@@ -0,0 +1,53 @@
+/**
+ * One header item of the list
+ */
+export default class ListHeaderModel {
+    /**
+     * constructor
+     */
+    constructor(header: Object, sorting?: SortingModel);
+    _key: string;
+    _header: {
+        label: string;
+        type: string;
+        layouthint: Array<string>;
+    };
+    _sortOption: SortOptionModel | null;
+    _readonlyWidth: $Keys<typeof ATTRIBUTE_WIDTH>;
+    /**
+     * Get key
+     */
+    get key(): string;
+    /**
+     * Getting the label of this header item
+     */
+    get label(): string;
+    /**
+     * Getting the type of this header item. For instance string, date, etc.
+     */
+    get type(): string;
+    /**
+     * Getting the layout hints of this header item
+     */
+    get layouthint(): LayoutHintCollection;
+    /**
+     * Get alignment of header label
+     */
+    get alignment(): string;
+    /**
+     */
+    get readonlyWidth(): $Keys<typeof ATTRIBUTE_WIDTH>;
+    /**
+     */
+    equals(listHeader: ListHeaderModel): boolean;
+    /**
+     */
+    get sortOption(): SortOptionModel | null;
+    /**
+     */
+    hasSorting(): boolean;
+}
+import SortOptionModel from "../sorting/SortOptionModel";
+import { ATTRIBUTE_WIDTH } from "../../constants";
+import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import SortingModel from "../sorting/SortingModel";

package/esm/models/list/ListModel.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Defines a list object
+ */
+export default class ListModel extends ResourceModel {
+    _detail: ListDetailModel | null;
+    _headers: Array<ListHeaderModel>;
+    _paging: PagingModel;
+    _filterCollection: FilterCollection;
+    _sorting: SortingModel;
+    _actionCollection: ActionCollection;
+    _listItemCollection: ListItemCollection;
+    _grouping: GroupingModel;
+    _selfhref: ListHref;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
+    /**
+     * Add detail model to the {ListModel}
+     */
+    set detail(detail: ModularUIModel | null);
+    /**
+     * Getting the detail
+     */
+    get detail(): ListDetailModel | null;
+    /**
+     * Getting the introduction text
+     */
+    get introtext(): string;
+    /**
+     * Set results
+     */
+    set listItemCollection(listItemCollection: ListItemCollection);
+    /**
+     * Getting the results
+     */
+    get listItemCollection(): ListItemCollection;
+    /**
+     * Retrieve grouping information
+     */
+    get grouping(): GroupingModel;
+    /**
+     */
+    setGrouping(): GroupingModel;
+    /**
+     */
+    hasGrouping(): boolean;
+    /**
+     * Check if list has results
+     */
+    hasResults(): boolean;
+    /**
+     */
+    get shouldHide(): boolean;
+    /**
+     * Get list item by ID
+     */
+    getListItemById(id: string | number): ListItemModel | null;
+    /**
+     * Get list item by Href
+     */
+    getListItemByHref(href: ListHref): ListItemModel | null;
+    /**
+     * Getting paging information
+     */
+    get paging(): PagingModel;
+    /**
+     */
+    setPaging(): PagingModel;
+    /**
+     * Getting sorting information
+     */
+    get sorting(): SortingModel;
+    /**
+     */
+    setSorting(): SortingModel;
+    /**
+     * Set filterCollection
+     */
+    set filterCollection(filterCollection: FilterCollection);
+    /**
+     * Getting the filters
+     */
+    get filterCollection(): FilterCollection;
+    /**
+     */
+    setFilters(): FilterCollection;
+    /**
+     * Indicates if list results are filtered
+     */
+    isFiltered(): boolean;
+    /**
+     * Getting actions
+     */
+    get actionCollection(): ActionCollection;
+    /**
+     */
+    setActionCollection(): ActionCollection;
+    /**
+     * Contains this model list data
+     */
+    hasList(): boolean;
+    /**
+     * Sets self href from links collection
+     */
+    setSelfHref(): ListHref;
+    /**
+     * Getting the self link of this list
+     */
+    get selfhref(): ListHref;
+    /**
+     * Getting the headers of this list
+     */
+    get headers(): Array<ListHeaderModel>;
+    /**
+     * Set initial headers of list
+     */
+    setHeaders(): Array<ListHeaderModel>;
+    /**
+     */
+    getSortingLabels(): {
+        [string]: string;
+    };
+    /**
+     * Retrieve all actions by type
+     */
+    getActionsByType(actionType: string): ActionCollection;
+    /**
+     * Retrieves the label of the first additional detail link by resource type
+     */
+    getAdditionalDetailLabel(resourceType: string): string | null;
+}
+import ResourceModel from "../base/ResourceModel";
+import ListDetailModel from "../list/ListDetailModel";
+import ListHeaderModel from "../list/ListHeaderModel";
+import PagingModel from "../paging/PagingModel";
+import FilterCollection from "../filters/FilterCollection";
+import SortingModel from "../sorting/SortingModel";
+import ActionCollection from "../actions/ActionCollection";
+import ListItemCollection from "../list/ListItemCollection";
+import GroupingModel from "../grouping/GroupingModel";
+import ListHref from "../href/ListHref";
+import { ModularUIModel } from "../types";
+import ListItemModel from "../list/ListItemModel";

package/esm/models/paging/PagesizeModel.d.ts

@@ -0,0 +1,25 @@
+/**
+ */
+export default class PagesizeModel {
+    /**
+     */
+    constructor(pagesize: number, pagesizeContributions: Object);
+    _pagesize: number;
+    _options: Array<number>;
+    /**
+     * Getting the name
+     */
+    get name(): string;
+    /**
+     * Setting the page size
+     */
+    set value(pagesize: number);
+    /**
+     * Geting the value
+     */
+    get value(): number;
+    /**
+     * Getting available pagesize options
+     */
+    get options(): Array<number>;
+}

package/esm/models/panels/GroupingPanelModel.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Panel that groups other panels
+ */
+export default class GroupingPanelModel extends ResourceModel {
+    /**
+     * Constructs GroupingPanel
+     */
+    constructor(modularuiResponse: ModularUIResponse);
+    _taskGroupCollection: TaskGroupCollection;
+    /**
+     */
+    get panelLinks(): LinkCollection;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
+    /**
+     * Check if an introtext exists for this caseview
+     */
+    hasIntroText(): boolean;
+    /**
+     * Getting the introduction text configured on the grouping panel
+     */
+    get introtext(): string;
+    /**
+     */
+    createTaskGroupCollection(): void;
+    /**
+     * Setting the taskgroup panel collection
+     */
+    set taskGroupCollection(taskgroups: Array<TaskGroupModel>);
+    /**
+     * Getting the taskgrouppanels on the tab
+     */
+    get taskGroupCollection(): TaskGroupCollection;
+    /**
+     * Has taskgroups
+     */
+    hasTaskGroups(): boolean;
+    /**
+     * Has tasks
+     */
+    hasTasks(): boolean;
+}
+import ResourceModel from "../base/ResourceModel";
+import TaskGroupCollection from "../taskgroup/TaskGroupCollection";
+import LinkCollection from "../links/LinkCollection";
+import { ModularUIModel } from "../types";
+import TaskGroupModel from "../taskgroup/TaskGroupModel";
+import { ModularUIResponse } from "../../modularui";

package/esm/models/sorting/SortOptionModel.d.ts

@@ -0,0 +1,48 @@
+export default SortOptionModel;
+/**
+ */
+declare class SortOptionModel {
+    /**
+     */
+    constructor(key: string, label?: string, group?: GroupModel | null);
+    _key: string;
+    _label: string;
+    _group: GroupModel | null;
+    _sortorder: "desc" | "asc";
+    _selected: boolean;
+    /**
+     */
+    set selected(selected: boolean);
+    /**
+     */
+    get selected(): boolean;
+    /**
+     */
+    get key(): string;
+    /**
+     */
+    get value(): string;
+    /**
+     */
+    get oppositeDirection(): "asc" | "desc";
+    /**
+     */
+    get oppositeValue(): string;
+    /**
+     */
+    get label(): string;
+    /**
+     */
+    set sortorder(sortorder: "desc" | "asc");
+    /**
+     */
+    get sortorder(): "desc" | "asc";
+    /**
+     */
+    get group(): GroupModel | null;
+    /**
+     */
+    getHref(listHref: ListHref): ListHref;
+}
+import { GroupModel } from "../grouping/GroupingModel";
+import ListHref from "../href/ListHref";

package/esm/models/sorting/SortingModel.d.ts

@@ -0,0 +1,42 @@
+export default SortingModel;
+/**
+ */
+declare class SortingModel extends BaseCollection<SortOptionModel> {
+    /**
+     */
+    constructor(contributions: Object, labels: {
+        [key: string]: string;
+    }, grouping: GroupingModel, currentSort: string);
+    collection: any;
+    /**
+     */
+    get name(): string;
+    /**
+     */
+    get value(): string;
+    /**
+     */
+    get param(): string;
+    /**
+     */
+    get options(): Array<SortOptionModel>;
+    /**
+     */
+    setSelected(currentSort?: string): void;
+    /**
+     * Retrieve a sort option from the model that can be used in the querystring to set it in the opposite direction
+     * For example a sort option in the model with key books and direction descending will be retrieved as 'Books asc'
+     */
+    getUpdateQuerystring(optionKey: string): string;
+    /**
+     * @see {@link SortingModel#getUpdateQuerystring}
+     */
+    getUpdateQuerystringBySortOption(sortOption: SortOptionModel): string;
+    /**
+     */
+    createListHref(listHref: ListHref, sortOption: SortOptionModel): ListHref;
+}
+import SortOptionModel from "../sorting/SortOptionModel";
+import BaseCollection from "../base/BaseCollection";
+import ListHref from "../href/ListHref";
+import GroupingModel from "../grouping/GroupingModel";

package/esm/models/tab/TabModel.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Describes a TabModel
+ */
+export default class TabModel extends ResourceModel {
+    /**
+     */
+    constructor(modularuiResponse: ModularUIResponse);
+    _actionCollection: ActionCollection;
+    _taskGroupCollection: TaskGroupCollection;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
+    /**
+     */
+    get searchLink(): LinkModel | null;
+    /**
+     */
+    createTaskGroupCollection(): void;
+    /**
+     * Setting the taskgroup panel collection
+     */
+    set taskGroupCollection(taskgroups: Array<TaskGroupModel>);
+    /**
+     * Getting the taskgrouppanels on the tab
+     */
+    get taskGroupCollection(): TaskGroupCollection;
+    /**
+     * Getting the component links on the tab
+     */
+    get components(): LinkCollection;
+    /**
+     */
+    get actionCollection(): ActionCollection;
+    /**
+     * Has component links
+     */
+    hasComponents(): boolean;
+    /**
+     * Has taskgroups
+     */
+    hasTaskGroups(): boolean;
+    /**
+     */
+    hasActions(): boolean;
+}
+import ResourceModel from "../base/ResourceModel";
+import ActionCollection from "../actions/ActionCollection";
+import TaskGroupCollection from "../taskgroup/TaskGroupCollection";
+import { ModularUIModel } from "../types";
+import LinkModel from "../links/LinkModel";
+import TaskGroupModel from "../taskgroup/TaskGroupModel";
+import LinkCollection from "../links/LinkCollection";
+import { ModularUIResponse } from "../../modularui";

package/esm/models/user/UserServicesModel.d.ts

@@ -0,0 +1,39 @@
+export default UserServicesModel;
+/**
+ * UserServicesModel model
+ */
+declare class UserServicesModel extends ResourceModel {
+    _user: UserModel | null;
+    _mustChangePassword: boolean;
+    /**
+     */
+    set mustChangePassword(mustChangePassword: boolean);
+    /**
+     */
+    get mustChangePassword(): boolean;
+    /**
+     * Set user data
+     */
+    set user(model: ModularUIModel | null);
+    /**
+     * return the user model for the current user
+     */
+    get user(): UserModel | null;
+    /**
+     */
+    get userLink(): LinkModel | null;
+    /**
+     */
+    get changePassword(): Href | null;
+    /**
+     */
+    get changeAvatar(): Href | null;
+    /**
+     */
+    get isLoggedIn(): boolean;
+}
+import ResourceModel from "../base/ResourceModel";
+import UserModel from "../user/UserModel";
+import { ModularUIModel } from "../types";
+import LinkModel from "../links/LinkModel";
+import Href from "../href/Href";

package/esm/modularui/Authenticate.d.ts

@@ -0,0 +1,46 @@
+export default Authenticate;
+/**
+ */
+declare class Authenticate {
+    _isBasic: boolean;
+    /**
+     */
+    get authenticationType(): $Keys<typeof INTERNAL_LOGIN_TYPE>;
+    /**
+     */
+    set isBasicAuthentication(isBasicAuthentication: boolean);
+    /**
+     */
+    get isBasicAuthentication(): boolean;
+    /**
+     */
+    requestLogin(): Promise<any>;
+    /**
+     */
+    initLogin(initLogin: boolean): Promise<any>;
+    /**
+     */
+    login(username: string, password: string): Promise<any>;
+    /**
+     */
+    getFormLoginUrl(): string;
+    /**
+     */
+    getFormLoginData(username: string, password: string): string;
+    /**
+     */
+    doFormLogin(username: string, password: string): Promise<any>;
+    /**
+     */
+    doBasicAuthentication(username: string, password: string): Promise<any>;
+    /**
+     */
+    doJaasAuthentication(username: string, password: string): Promise<any>;
+    /**
+     */
+    getLogoutUrl(): string;
+    /**
+     */
+    logout(): Promise<any>;
+}
+import { INTERNAL_LOGIN_TYPE } from "../constants";