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

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

@@ -0,0 +1,135 @@
+/**
+ * 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;
+    /**
+     * Add detail model to the {ListModel}
+     */
+    set detail(arg: ListDetailModel);
+    /**
+     * Getting the detail
+     */
+    get detail(): ListDetailModel;
+    /**
+     * Getting the introduction text
+     */
+    get introtext(): string;
+    /**
+     * Set results
+     */
+    set listItemCollection(arg: 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(arg: 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(): ListHeaderModel[];
+    /**
+     * Set initial headers of list
+     */
+    setHeaders(): Array<ListHeaderModel>;
+    /**
+     */
+    getSortingLabels(): {
+        [string]: string;
+    };
+    /**
+     * Retrieve all actions by type
+     */
+    getActionsByType(actionType: string): ActionCollection;
+}
+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 ListItemModel from "../list/ListItemModel";

package/types/models/lookup/LookupOptionCollection.d.ts

@@ -0,0 +1,11 @@
+export default LookupOptionCollection;
+/**
+ */
+declare class LookupOptionCollection extends ResourceCollection<ChoiceAttributeOptionModel, any> {
+    /**
+     */
+    static create(data: Object, contributions: Object): LookupOptionCollection;
+    constructor(initCollection?: ChoiceAttributeOptionModel[]);
+}
+import ChoiceAttributeOptionModel from "../attributes/ChoiceAttributeOptionModel";
+import ResourceCollection from "../base/ResourceCollection";

package/types/models/lookup/LookupOptionsModel.d.ts

@@ -0,0 +1,19 @@
+/**
+ */
+export default class LookupOptionsModel extends ResourceModel {
+    _options: LookupOptionCollection;
+    _filterCollection: FilterCollection | null;
+    /**
+     */
+    get options(): LookupOptionCollection;
+    /**
+     */
+    createFilterCollection(data: Object, contributions: Object): FilterCollection;
+    /**
+     * Getting the filters
+     */
+    get filterCollection(): FilterCollection;
+}
+import ResourceModel from "../base/ResourceModel";
+import LookupOptionCollection from "../lookup/LookupOptionCollection";
+import FilterCollection from "../filters/FilterCollection";

package/types/models/modelcatalog/ModelCatalogModel.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The Application model
+ */
+export default class ModelCatalogModel extends ResourceModel {
+    /**
+     */
+    static isApplicableModel(data: Object): boolean;
+    /**
+     * Retrieve link to Concept Index model
+     */
+    get conceptIndexLink(): LinkModel;
+    /**
+     * Retrieve link to Content Index model
+     */
+    get contentIndexLink(): LinkModel;
+}
+import ResourceModel from "../base/ResourceModel";
+import LinkModel from "../links/LinkModel";

package/types/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(arg: number);
+    /**
+     * Geting the value
+     */
+    get value(): number;
+    /**
+     * Getting available pagesize options
+     */
+    get options(): number[];
+}

package/types/models/paging/PagingModel.d.ts

@@ -0,0 +1,49 @@
+/**
+ */
+export default class PagingModel {
+    /**
+     */
+    constructor(paging: Object, pagingContributions: Object);
+    _contributions: Object;
+    _paging: Object;
+    _pagesize: PagesizeModel;
+    _isEnabled: boolean;
+    /**
+     */
+    get contributions(): Object;
+    /**
+     */
+    get isEnabled(): boolean;
+    /**
+     * Getting paging information
+     */
+    get paging(): Object;
+    /**
+     * Get the paging parameter name
+     */
+    get name(): string;
+    /**
+     * Getting paging value
+     */
+    get value(): number;
+    /**
+     * Get maximum pages
+     */
+    get maxpages(): number;
+    /**
+     * Set current page
+     */
+    set page(arg: number);
+    /**
+     * Get current page
+     */
+    get page(): number;
+    /**
+     * Get the total number of results
+     */
+    get totalResults(): number;
+    /**
+     */
+    get pagesize(): PagesizeModel;
+}
+import PagesizeModel from "../paging/PagesizeModel";

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

@@ -0,0 +1,39 @@
+/**
+ * Panel that groups other panels
+ */
+export default class GroupingPanelModel extends ResourceModel {
+    _taskGroupCollection: TaskGroupCollection;
+    /**
+     */
+    get panelLinks(): LinkCollection;
+    /**
+     * 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(arg: TaskGroupCollection);
+    /**
+     * 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";

package/types/models/parameter/Parameter.d.ts

@@ -0,0 +1,40 @@
+export default Parameter;
+/**
+ * Querystring parameter
+ */
+declare class Parameter {
+    /**
+     * Create parameter from string input
+     */
+    static fromString(parameter: string): null | Parameter;
+    /**
+     */
+    constructor(prefix: string | null, name: string, value: string | null);
+    _prefix: string | null;
+    _name: string;
+    _value: string | null;
+    _isModUIParameter: boolean | null;
+    /**
+     * Getting prefix
+     */
+    get prefix(): string;
+    /**
+     * Getting name
+     */
+    get name(): string;
+    /**
+     * Getting value
+     */
+    get value(): string;
+    /**
+     * Convert parameter to string
+     */
+    toString(withPrefix?: boolean): string;
+    /**
+     */
+    toQuerystring(withPrefix?: boolean): string;
+    /**
+     * Indicates if parameter can be send to the Be Informed modular UI
+     */
+    get isModUIParameter(): boolean;
+}

package/types/models/process/ProcessStatusSettingsModel.d.ts

@@ -0,0 +1,38 @@
+/**
+ */
+export default class ProcessStatusSettingsModel extends BaseModel {
+    /**
+     */
+    get concequenceType(): string;
+    /**
+     */
+    get transition(): string;
+    /**
+     */
+    get isApplicable(): boolean;
+    /**
+     */
+    get isCompleted(): boolean;
+    /**
+     */
+    get isNeeded(): boolean;
+    /**
+     */
+    get state(): string;
+    /**
+     */
+    get canComplete(): boolean;
+    /**
+     */
+    get links(): LinkCollection;
+    /**
+     */
+    get referenceDate(): ISO_DATE;
+    /**
+     * Retrieve concept link of attribute when available
+     */
+    get conceptLink(): LinkModel;
+}
+import BaseModel from "../base/BaseModel";
+import LinkCollection from "../links/LinkCollection";
+import LinkModel from "../links/LinkModel";

package/types/models/resolveModel.d.ts

@@ -0,0 +1,7 @@
+export default resolveModel;
+/**
+ * Resolve a model by resource
+ */
+declare function resolveModel(data: ModularUIResponse): Class<ModularUIModel> | null;
+import ModularUIResponse from "../modularui/ModularUIResponse";
+import { ModularUIModel } from "./types";

package/types/models/search/CaseSearchModel.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Case search model
+ */
+export default class CaseSearchModel extends ListModel {
+    /**
+     * Retrieve quick search filters
+     */
+    getQuickSearchFilters(): Array<FilterType>;
+    /**
+     */
+    hasQuickSearchFilters(): boolean;
+}
+import ListModel from "../list/ListModel";
+import { FilterType } from "../types";

package/types/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(arg: boolean);
+    /**
+     */
+    get selected(): boolean;
+    /**
+     */
+    get key(): string;
+    /**
+     */
+    get value(): string;
+    /**
+     */
+    get oppositeDirection(): "desc" | "asc";
+    /**
+     */
+    get oppositeValue(): string;
+    /**
+     */
+    get label(): string;
+    /**
+     */
+    set sortorder(arg: "desc" | "asc");
+    /**
+     */
+    get sortorder(): "desc" | "asc";
+    /**
+     */
+    get group(): GroupModel;
+    /**
+     */
+    getHref(listHref: ListHref): ListHref;
+}
+import { GroupModel } from "../grouping/GroupingModel";
+import ListHref from "../href/ListHref";

package/types/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(): 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 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/types/models/tab/TabModel.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Describes a TabModel
+ */
+export default class TabModel extends ResourceModel {
+    _actionCollection: ActionCollection;
+    _taskGroupCollection: TaskGroupCollection;
+    /**
+     */
+    get searchLink(): LinkModel;
+    /**
+     */
+    createTaskGroupCollection(): void;
+    /**
+     * Setting the taskgroup panel collection
+     */
+    set taskGroupCollection(arg: TaskGroupCollection);
+    /**
+     * 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 LinkModel from "../links/LinkModel";
+import LinkCollection from "../links/LinkCollection";

package/types/models/taskgroup/TaskGroupCollection.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Collection of taskgroup models
+ */
+export default class TaskGroupCollection extends BaseCollection<TaskGroupModel> {
+    constructor(initCollection?: TaskGroupModel[]);
+    /**
+     * Indicates if the taskgroup collection has has tasks
+     */
+    hasTasks(): boolean;
+}
+import TaskGroupModel from "../taskgroup/TaskGroupModel";
+import BaseCollection from "../base/BaseCollection";

package/types/models/taskgroup/TaskGroupModel.d.ts

@@ -0,0 +1,15 @@
+/**
+ * TaskGroupModel
+ */
+export default class TaskGroupModel extends ResourceModel {
+    /**
+     */
+    static create(key: string, data: Object, contributions: Object): TaskGroupModel;
+    _actionCollection: ActionCollection;
+    /**
+     * Retrieve actions of taskgroup
+     */
+    get actionCollection(): ActionCollection;
+}
+import ResourceModel from "../base/ResourceModel";
+import ActionCollection from "../actions/ActionCollection";