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

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

@@ -0,0 +1,85 @@
+/**
+ * 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>);
+    _group: Object;
+    _context: Object;
+    _attributeCollection: AttributeCollection;
+    _grouping: GroupingModel | null;
+    /**
+     */
+    get type(): string;
+    /**
+     */
+    get id(): string;
+    /**
+     */
+    get label(): string;
+    /**
+     */
+    get attributeCollection(): AttributeCollection;
+    /**
+     */
+    get grouping(): GroupingModel;
+    /**
+     * Retrieve array of reference id's
+     */
+    get reference(): 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>);
+    _prefix: string | null;
+    _groups: Array<GroupModel>;
+    /**
+     */
+    createGroup(data: Object, contributions: Array<Context>): Array<Object>;
+    /**
+     * add grouped prefix to the dynamicschema
+     */
+    getDynamicSchema(group: Object, dynamicschema: Object): Object;
+    /**
+     * Retrieve groups of grouping
+     */
+    get groups(): 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";
+type Context = {
+    prefix: string;
+    label: string;
+    metadata: Object;
+    attributes: Object[];
+};
+export {};

package/types/models/href/Href.d.ts

@@ -0,0 +1,17 @@
+type HrefInput = any;
+export default Href;
+/**
+ * Defines a Href with the parameters
+ */
+declare class Href {
+    _path: string;
+    _hash: string;
+    _parameters: Array<Parameter>;
+    _resourcetype: string;
+    _method: $Keys<{
+        POST: string;
+        GET: string;
+    }>;
+    _state: {} | null;
+}
+import Parameter from "../parameter/Parameter";

package/types/models/href/ListHref.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Class representing the href of a list. It adds paging, sorting and filter parameters where necessary
+ *
+ * @augments Href
+ */
+export default class ListHref extends Href {
+    /**
+     * Create a ListHref
+     */
+    constructor(href?: HrefInput, list?: ListModel, isPrefixed?: boolean);
+    _isPrefixed: boolean;
+    _prefix: string | null;
+    _pagingName: string;
+    _pagesizeName: string;
+    _sortingName: string;
+    /**
+     * Retrieve parameter names from Href
+     */
+    setParameterNamesFromHref(href: ListHref): void;
+    /**
+     * Retrieve parameter names and settings from List model
+     */
+    setParameterNamesFromListModel(list: ListModel): void;
+    /**
+     * Setting the current page
+     */
+    set page(arg: Parameter);
+    /**
+     */
+    get page(): Parameter;
+    /**
+     * Setting the page size
+     */
+    set pagesize(arg: number);
+    /**
+     * Setting the sort value
+     */
+    set sort(arg: string);
+    /**
+     * Add filter parameters to the parameter collection
+     */
+    set filterCollection(arg: FilterCollection);
+    /**
+     * Getting prefix
+     */
+    get prefix(): string;
+    /**
+     * Getting paging name
+     */
+    get pagingName(): string;
+    /**
+     * Getting pagesize name
+     */
+    get pagesizeName(): string;
+    /**
+     * Getting sorting name
+     */
+    get sortingName(): string;
+}
+import Href from "./Href";
+import ListModel from "../list/ListModel";
+import Parameter from "../parameter/Parameter";
+import FilterCollection from "../filters/FilterCollection";
+import { HrefInput } from "./Href";

package/types/models/index.d.ts

@@ -0,0 +1,94 @@
+export { default as resolveModel } from "./resolveModel";
+export { default as BaseCollection } from "./base/BaseCollection";
+export { default as ActionCollection } from "./actions/ActionCollection";
+export { default as ActionModel } from "./actions/ActionModel";
+export { default as AttributeCollection } from "./attributes/AttributeCollection";
+export { default as AttributeSetModel } from "./attributes/AttributeSetModel";
+export { default as AttributeModel } from "./attributes/AttributeModel";
+export { default as ChoiceAttributeOptionCollection } from "./attributes/ChoiceAttributeOptionCollection";
+export { default as ChoiceAttributeOptionModel } from "./attributes/ChoiceAttributeOptionModel";
+export { default as CompositeAttributeChildCollection } from "./attributes/CompositeAttributeChildCollection";
+export { default as AttributeContent } from "./attributes/AttributeContent";
+export { default as BaseLayoutHintRule } from "./attributes/layouthint-rules/BaseLayoutHintRule";
+export { default as DependentAttribute } from "./attributes/layouthint-rules/DependentAttribute";
+export { default as RemainingTotalUploadSize } from "./attributes/layouthint-rules/RemainingTotalUploadSize";
+export { default as ConceptLinkModel } from "./concepts/ConceptLinkModel";
+export { default as ConceptRelationCollection } from "./concepts/ConceptRelationCollection";
+export { default as ConceptRelationModel } from "./concepts/ConceptRelationModel";
+export { default as SourceReferenceCollection } from "./concepts/SourceReferenceCollection";
+export { default as SourceReferenceModel } from "./concepts/SourceReferenceModel";
+export { default as ConstraintCollection } from "./attributes/input-constraints/ConstraintCollection";
+export { default as ConstraintModel } from "./attributes/input-constraints/ConstraintModel";
+export { default as ContentLinkModel } from "./content/ContentLinkModel";
+export { default as SectionModel } from "./content/SectionModel";
+export { default as SubSectionModel } from "./content/SubSectionModel";
+export { default as ContentConfiguration } from "./contentconfiguration/ContentConfiguration";
+export { default as ContentConfigurationElements } from "./contentconfiguration/ContentConfigurationElements";
+export { default as ContentConfigurationEndResults } from "./contentconfiguration/ContentConfigurationEndResults";
+export { default as ContentConfigurationQuestions } from "./contentconfiguration/ContentConfigurationQuestions";
+export { default as ContentConfigurationResults } from "./contentconfiguration/ContentConfigurationResults";
+export { default as ErrorCollection } from "./error/ErrorCollection";
+export { default as ErrorModel } from "./error/ErrorModel";
+export { default as ErrorResponse } from "./error/ErrorResponse";
+export { default as FilterCollection } from "./filters/FilterCollection";
+export { default as FormObjectModel } from "./form/FormObjectModel";
+export { default as Href } from "./href/Href";
+export { default as ListHref } from "./href/ListHref";
+export { default as LinkCollection } from "./links/LinkCollection";
+export { default as LinkModel } from "./links/LinkModel";
+export { default as ListHeaderModel } from "./list/ListHeaderModel";
+export { default as ListItemCollection } from "./list/ListItemCollection";
+export { default as ListItemModel } from "./list/ListItemModel";
+export { default as LookupOptionsModel } from "./lookup/LookupOptionsModel";
+export { default as LookupOptionCollection } from "./lookup/LookupOptionCollection";
+export { default as ProcessStatusSettingsModel } from "./process/ProcessStatusSettingsModel";
+export { default as PagesizeModel } from "./paging/PagesizeModel";
+export { default as PagingModel } from "./paging/PagingModel";
+export { default as Parameter } from "./parameter/Parameter";
+export { default as SortingModel } from "./sorting/SortingModel";
+export { default as SortOptionModel } from "./sorting/SortOptionModel";
+export { default as TaskGroupCollection } from "./taskgroup/TaskGroupCollection";
+export * from "./types";
+import { default as ApplicationModel } from "./application/ApplicationModel";
+import { default as CaseSearchModel } from "./search/CaseSearchModel";
+import { default as CaseViewModel } from "./caseview/CaseViewModel";
+import { default as ListDetailModel } from "./list/ListDetailModel";
+import { default as DetailModel } from "./detail/DetailModel";
+import { default as FormModel } from "./form/FormModel";
+import { default as GroupingPanelModel } from "./panels/GroupingPanelModel";
+import { default as ListModel } from "./list/ListModel";
+import { default as TabModel } from "./tab/TabModel";
+import { default as TaskGroupModel } from "./taskgroup/TaskGroupModel";
+import { default as UserModel } from "./user/UserModel";
+import { default as UserProfileModel } from "./user/UserProfileModel";
+import { default as UserServicesModel } from "./user/UserServicesModel";
+import { default as ModelCatalogModel } from "./modelcatalog/ModelCatalogModel";
+import { default as ConceptIndexModel } from "./concepts/ConceptIndexModel";
+import { default as ConceptDetailModel } from "./concepts/ConceptDetailModel";
+import { default as BusinessScenarioModel } from "./concepts/BusinessScenarioModel";
+import { default as ConceptTypeDetailModel } from "./concepts/ConceptTypeDetailModel";
+import { default as ContentIndexModel } from "./content/ContentIndexModel";
+import { default as ContentTOCModel } from "./content/ContentTOCModel";
+import { default as ContentModel } from "./content/ContentModel";
+import { default as ContentTypeModel } from "./content/ContentTypeModel";
+import { default as BooleanAttributeModel } from "./attributes/BooleanAttributeModel";
+import { default as CaptchaAttributeModel } from "./attributes/CaptchaAttributeModel";
+import { default as ChoiceAttributeModel } from "./attributes/ChoiceAttributeModel";
+import { default as DatetimeAttributeModel } from "./attributes/DatetimeAttributeModel";
+import { default as HelptextAttributeModel } from "./attributes/HelptextAttributeModel";
+import { default as LabelAttributeModel } from "./attributes/LabelAttributeModel";
+import { default as MemoAttributeModel } from "./attributes/MemoAttributeModel";
+import { default as MoneyAttributeModel } from "./attributes/MoneyAttributeModel";
+import { default as NumberAttributeModel } from "./attributes/NumberAttributeModel";
+import { default as PasswordAttributeModel } from "./attributes/PasswordAttributeModel";
+import { default as CompositeAttributeModel } from "./attributes/CompositeAttributeModel";
+import { default as StringAttributeModel } from "./attributes/StringAttributeModel";
+import { default as UploadAttributeModel } from "./attributes/UploadAttributeModel";
+import { default as XMLAttributeModel } from "./attributes/XMLAttributeModel";
+import { default as AssignmentFilterModel } from "./filters/AssignmentFilterModel";
+import { default as FilterModel } from "./filters/FilterModel";
+import { default as RangeFilterModel } from "./filters/RangeFilterModel";
+import { default as ConceptIndexFilterModel } from "./filters/ConceptIndexFilterModel";
+export { ApplicationModel, CaseSearchModel, CaseViewModel, ListDetailModel, DetailModel, FormModel, GroupingPanelModel, ListModel, TabModel, TaskGroupModel, UserModel, UserProfileModel, UserServicesModel, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, BusinessScenarioModel, ConceptTypeDetailModel, ContentIndexModel, ContentTOCModel, ContentModel, ContentTypeModel, BooleanAttributeModel, CaptchaAttributeModel, ChoiceAttributeModel, DatetimeAttributeModel, HelptextAttributeModel, LabelAttributeModel, MemoAttributeModel, MoneyAttributeModel, NumberAttributeModel, PasswordAttributeModel, CompositeAttributeModel, StringAttributeModel, UploadAttributeModel, XMLAttributeModel, AssignmentFilterModel, FilterModel, RangeFilterModel, ConceptIndexFilterModel };
+export { default as LayoutHintRuleCollection, addLayoutHintRule, updateLayoutHintRules } from "./attributes/layouthint-rules/LayoutHintRuleCollection";
+export { default as GroupingModel, GroupModel } from "./grouping/GroupingModel";

package/types/models/layouthint/LayoutHintCollection.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Collection of layouthint
+ */
+export default class LayoutHintCollection extends BaseCollection<string> {
+    /**
+     * Constructs the layouthint collection
+     */
+    constructor(layouthint?: Array<string>);
+    /**
+     * Retrieve layout hints
+     */
+    get layouthint(): string[];
+    /**
+     * Checks if a specific layouthint exists in the component configuration
+     * This method matches all exact matches and hints starting with. For example
+     * when calling layouth.has("hide"), this will return true for both "hide" and "hide-when-empty".
+     * If only exact matches are required, use the method {@link hasExact}.
+     */
+    has(...hints: Array<string>): boolean;
+    /**
+     * Checks if a specific layouthint exists in the component configuration,
+     * only checks on exact matches.
+     * If layouthints that start with the given hint should also match, use {@link has}.
+     * @param hints
+     * @returns {boolean}
+     */
+    hasExact(...hints: Array<string>): boolean;
+    /**
+     * Retrieve the first layouthint starting with hint
+     */
+    getByLayoutHint(hint: Function | string): null | string;
+    /**
+     * Get the value of a specific hint
+     * Format: hint=value
+     */
+    getLayoutHintValue(hint: string): string | null;
+    /**
+     * Get an array of multiple values from a specific hint
+     * Format: hint=value1;value2;value3
+     */
+    getLayoutHintValues(hint: string): Array<string> | null;
+}
+import BaseCollection from "../base/BaseCollection";

package/types/models/links/LinkCollection.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Collection of links
+ *
+ * @see {LinkModel}
+ */
+export default class LinkCollection extends BaseCollection<LinkModel> {
+    /**
+     * Constructs the link collection
+     */
+    constructor(linkData?: Object, linkContributions?: Object);
+    /**
+     * Set Link collection
+     */
+    set links(arg: LinkModel[]);
+    /**
+     * Getting links
+     */
+    get links(): LinkModel[];
+    /**
+     * Get a link by it's key, handy for getting the self link
+     */
+    getLinkByKey(key: string): LinkModel | null;
+    /**
+     * Get a link by it's Href
+     */
+    getLinkByHref(href: Href | string): LinkModel | null;
+    /**
+     * Getting the links by group key. For instance getting all 'tab' links of the web application.
+     */
+    getLinksByGroup(...args: Array<string>): LinkCollection;
+    /**
+     * Retrieve links by resource type
+     */
+    getLinkByResourceType(resourceType: string): LinkCollection;
+    /**
+     * Retrieve links including a layout hint
+     */
+    getLinksByLayoutHint(hint: string): LinkCollection;
+    /**
+     * Indicates if a link with layout hint exists
+     */
+    hasLinksByLayoutHint(hint: string): boolean;
+    /**
+     * Get all href of links in collection in an array of Href's
+     */
+    toHrefArray(): Array<Href>;
+    /**
+     * Check if link exists in collection
+     */
+    hasLink(link: LinkModel): boolean;
+    /**
+     * Updates the collection with a new link, when the link to update does not exist, it is added to the collection
+     */
+    update(newLink: LinkModel): LinkCollection;
+    /**
+     * Use as path regex for react router routes
+     */
+    get routePath(): string;
+}
+import LinkModel from "./LinkModel";
+import BaseCollection from "../base/BaseCollection";
+import Href from "../href/Href";

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

@@ -0,0 +1,92 @@
+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): LinkModel;
+    _href: Href;
+    _isCacheable: boolean;
+    _icon: string;
+    _targetModel: Class<ModularUIModel>;
+    /**
+     */
+    createHref(): void;
+    /**
+     * Set the href of the Link
+     */
+    set href(arg: 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(arg: string);
+    /**
+     * Retrieve icon of LinkModel
+     */
+    get icon(): string;
+    /**
+     */
+    set targetModel(arg: Class<ModularUIModel>);
+    /**
+     */
+    get targetModel(): Class<ModularUIModel>;
+    /**
+     */
+    set isCacheable(arg: boolean);
+    /**
+     */
+    get isCacheable(): boolean;
+    /**
+     */
+    get filterName(): string;
+    /**
+     */
+    get hasProcessStatusSettings(): boolean;
+    /**
+     */
+    get processStatus(): ProcessStatusSettingsModel;
+}
+import BaseModel from "../base/BaseModel";
+import Href from "../href/Href";
+import { ModularUIModel } from "../types";
+import LinkCollection from "../links/LinkCollection";
+import ProcessStatusSettingsModel from "../process/ProcessStatusSettingsModel";

package/types/models/links/normalizeLinkJSON.d.ts

@@ -0,0 +1,9 @@
+export default normalizeLinkJSON;
+/**
+ * Normalize various link formats from services into a concistent format
+ * @private
+ */
+declare function normalizeLinkJSON(data: Object, contributions: Object): {
+    data: any;
+    contributions: any;
+}[];

package/types/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(arg: ListItemModel);
+    /**
+     * Get listitem
+     */
+    get listitem(): ListItemModel;
+    /**
+     * Getting panel links
+     */
+    get panelLinks(): LinkCollection;
+    /**
+     */
+    set contentConfiguration(arg: 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;
+    /**
+     */
+    get hasResults(): boolean;
+    /**
+     */
+    get results(): CompositeAttributeModel;
+    /**
+     */
+    get hasEventData(): boolean;
+    /**
+     */
+    addAttributes(key: string, eventData: Object, eventContributions: Object): void;
+    /**
+     */
+    setEventData(): void;
+    /**
+     */
+    get eventdata(): 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/types/models/list/ListHeaderModel.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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<{
+        EXTRA_SMALL: string;
+        SMALL: string;
+        MEDIUM: string;
+        LARGE: string;
+        EXTRA_LARGE: string;
+    }>;
+    /**
+     * 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<{
+        EXTRA_SMALL: string;
+        SMALL: string;
+        MEDIUM: string;
+        LARGE: string;
+        EXTRA_LARGE: string;
+    }>;
+    /**
+     */
+    equals(listHeader: ListHeaderModel): boolean;
+    /**
+     */
+    get sortOption(): SortOptionModel;
+    /**
+     */
+    hasSorting(): boolean;
+}
+import SortOptionModel from "../sorting/SortOptionModel";
+import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import SortingModel from "../sorting/SortingModel";

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

@@ -0,0 +1,21 @@
+export default ListItemCollection;
+/**
+ * Collection of list items
+ */
+declare class ListItemCollection extends BaseCollection<ListItemModel> {
+    /**
+     * Create a list item collection from the given list
+     */
+    static createFromList(list: ListModel): ListItemCollection;
+    constructor(initCollection?: ListItemModel[]);
+    /**
+     */
+    get additionalDetailRoutePath(): string;
+    /**
+     */
+    get actionCollection(): ActionCollection;
+}
+import ListItemModel from "../list/ListItemModel";
+import BaseCollection from "../base/BaseCollection";
+import ActionCollection from "../actions/ActionCollection";
+import ListModel from "../list/ListModel";

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

@@ -0,0 +1,34 @@
+/**
+ * List Item
+ */
+export default class ListItemModel extends DetailModel {
+    /**
+     */
+    static createFromListResult(key: string, data: Object, contributions: Object): ListItemModel;
+    /**
+     */
+    static createFromChoiceAttributeOption(option: ChoiceAttributeOptionModel): ListItemModel;
+    /**
+     */
+    get caseviewHref(): Href;
+    /**
+     * Getting panel links
+     */
+    get panelLinks(): LinkCollection;
+    /**
+     * Check if list item has panel links
+     */
+    hasPanelLinks(): boolean;
+    /**
+     * Retrieve all actions by type
+     */
+    getActionsByType(actionType: string): ActionCollection;
+    /**
+     */
+    get additionalDetailRoutePath(): string;
+}
+import DetailModel from "../detail/DetailModel";
+import Href from "../href/Href";
+import LinkCollection from "../links/LinkCollection";
+import ActionCollection from "../actions/ActionCollection";
+import ChoiceAttributeOptionModel from "../attributes/ChoiceAttributeOptionModel";