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

package/types/models/content/ContentTOCModel.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Content detail model
+ */
+export default class ContentTOCModel extends ResourceModel {
+    _contentType: ContentTypeModel | null;
+    _filterCollection: FilterCollection;
+    /**
+     */
+    set contentType(arg: ContentTypeModel);
+    /**
+     * Retrieve content type model
+     */
+    get contentType(): ContentTypeModel;
+    /**
+     */
+    get selfContentLink(): ContentLinkModel;
+    /**
+     * Get sub items of toc
+     */
+    get items(): ContentLinkModel[];
+    /**
+     * get categories of content
+     */
+    get categories(): ContentLinkModel[];
+    /**
+     * Retrieve available filters on concept toc
+     */
+    get filterCollection(): FilterCollection;
+    /**
+     * Retrieve entrydate of content toc
+     */
+    get entryDate(): any;
+}
+import ResourceModel from "../base/ResourceModel";
+import ContentTypeModel from "./ContentTypeModel";
+import FilterCollection from "../filters/FilterCollection";
+import ContentLinkModel from "./ContentLinkModel";

package/types/models/content/ContentTypeModel.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Model for concept details, available through modelcatalog
+ */
+export default class ContentTypeModel extends ResourceModel {
+    /**
+     * Get content type icon
+     */
+    get icon(): string;
+    /**
+     * Get content type small icon
+     */
+    get iconSmall(): string;
+    /**
+     * Get content type medium icon
+     */
+    get iconMedium(): string;
+    /**
+     * Get content type large icon
+     */
+    get iconLarge(): string;
+    /**
+     * Get concept type text color
+     */
+    get description(): string;
+}
+import ResourceModel from "../base/ResourceModel";

package/types/models/content/SectionModel.d.ts

@@ -0,0 +1,75 @@
+export default SectionModel;
+/**
+ */
+declare class SectionModel extends BaseModel {
+    constructor(data: Object, entryDate: ISO_DATE | null);
+    _entryDate: ISO_DATE | null;
+    _selflink: LinkModel | null;
+    _childSections: Array<SectionModel>;
+    /**
+     */
+    get referred(): boolean;
+    /**
+     */
+    get selflink(): LinkModel;
+    /**
+     */
+    get selfhref(): Href;
+    /**
+     */
+    get entryDate(): any;
+    /**
+     */
+    get type(): string;
+    /**
+     */
+    get sourceLabel(): string;
+    /**
+     */
+    get id(): string;
+    /**
+     */
+    get key(): string;
+    /**
+     * Get content label
+     */
+    get label(): string;
+    /**
+     * Retrieve number of section
+     */
+    get number(): string;
+    /**
+     * Get content body
+     */
+    get body(): string;
+    /**
+     * Retrieve child section links
+     */
+    get childSectionLinks(): ContentLinkModel[];
+    /**
+     */
+    get selfContentLink(): ContentLinkModel;
+    /**
+     * set resolved child sections
+     */
+    set childSections(arg: SectionModel[]);
+    /**
+     * Get tree of child sections
+     */
+    get childSections(): SectionModel[];
+    /**
+     * Get sub sections
+     */
+    get subSections(): SubSectionModel[];
+    /**
+     */
+    get referenceHash(): number;
+    /**
+     */
+    getReferredSections(): Array<SubSectionModel | SectionModel>;
+}
+import BaseModel from "../base/BaseModel";
+import LinkModel from "../links/LinkModel";
+import Href from "../href/Href";
+import ContentLinkModel from "./ContentLinkModel";
+import SubSectionModel from "./SubSectionModel";

package/types/models/content/SubSectionModel.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Link to a concept
+ */
+export default class SubSectionModel extends BaseModel {
+    /**
+     */
+    constructor(data: Object);
+    _links: LinkCollection;
+    /**
+     */
+    get referred(): boolean;
+    /**
+     */
+    get id(): string;
+    /**
+     * Retrieve key of subsection
+     */
+    get key(): string;
+    /**
+     * Retrieve html body
+     */
+    get body(): string;
+    /**
+     * Retrieve number of section
+     */
+    get number(): string;
+    /**
+     * Retrieve label of section
+     */
+    get label(): string;
+    /**
+     * Get sub sections
+     */
+    get subSections(): SubSectionModel[];
+    /**
+     * Retrieve links of section
+     */
+    get links(): LinkCollection;
+    /**
+     * Get self link of model
+     */
+    get selflink(): LinkModel;
+    /**
+     * Return default self link of resource
+     */
+    get selfhref(): Href;
+    /**
+     */
+    get relatedConceptsHrefs(): Href[];
+    /**
+     * Get related concepts link
+     */
+    get relatedConceptsHref(): Href;
+    /**
+     */
+    get referenceHash(): number;
+    /**
+     */
+    getReferredSections(): Array<SubSectionModel>;
+}
+import BaseModel from "../base/BaseModel";
+import LinkCollection from "../links/LinkCollection";
+import LinkModel from "../links/LinkModel";
+import Href from "../href/Href";

package/types/models/contentconfiguration/ContentConfiguration.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Content definition for questions, results, given answers etc.
+ * Mostly maps to the Instrument questions configuration of Be Informed
+ */
+export default class ContentConfiguration {
+    /**
+     */
+    constructor(contentConfiguration: Object);
+    _config: Object;
+    /**
+     */
+    get questions(): ContentConfigurationQuestions;
+    /**
+     */
+    isConfiguredIntermediateResultAttribute(attributeKey: string): boolean;
+    /**
+     */
+    get intermediateResults(): ContentConfigurationResults;
+    /**
+     */
+    isConfiguredEndResultAttribute(attributeKey: string): boolean;
+    /**
+     */
+    get endResults(): ContentConfigurationEndResults;
+}
+import ContentConfigurationQuestions from "./ContentConfigurationQuestions";
+import ContentConfigurationResults from "./ContentConfigurationResults";
+import ContentConfigurationEndResults from "./ContentConfigurationEndResults";

package/types/models/contentconfiguration/ContentConfigurationElements.d.ts

@@ -0,0 +1,47 @@
+export default ContentConfigurationElements;
+/**
+ * Get element configuration of instrument questions
+ */
+declare class ContentConfigurationElements {
+    /**
+     */
+    constructor(elementConfiguration: Array<Object> | null);
+    _hasConfiguration: boolean;
+    _elementConfiguration: Array<Object>;
+    /**
+     */
+    includeLayoutHints(hints: Array<string>): ContentConfigurationElements;
+    /**
+     */
+    excludeLayoutHints(hints: Array<string>): ContentConfigurationElements;
+    /**
+     */
+    get config(): Object[];
+    /**
+     */
+    hasConfig(): boolean;
+    /**
+     */
+    hasContent(): boolean;
+    /**
+     * Retrieve if the configuration has an element that has a specific layouthint,
+     * makes it easy to indicate that the content needs to be presented in a certain way.
+     */
+    hasLayoutHint(hint: string): boolean;
+    /**
+     * Returns config elements by given types
+     */
+    byTypes(types?: Array<string>): Array<Object>;
+    /**
+     * Get label config elements
+     */
+    get labelConfig(): Object[];
+    /**
+     * Get all section reference types
+     */
+    getAllSectionReferenceTypes(): Array<any>;
+    /**
+     * Retrieve all content element configuration by content type
+     */
+    getContentElementConfigBySectionReferenceType(type: string): Array<Object>;
+}

package/types/models/contentconfiguration/ContentConfigurationEndResults.d.ts

@@ -0,0 +1,16 @@
+export default ContentConfigurationEndResults;
+/**
+ */
+declare class ContentConfigurationEndResults {
+    /**
+     */
+    constructor(configuration: Array<Object>);
+    _configuration: Array<Object>;
+    /**
+     */
+    get config(): ContentConfigurationResults[];
+    /**
+     */
+    getContentConfigurationElementsForAttribute(attributeKey: string): ContentConfigurationResults | null;
+}
+import ContentConfigurationResults from "./ContentConfigurationResults";

package/types/models/contentconfiguration/ContentConfigurationQuestions.d.ts

@@ -0,0 +1,22 @@
+export default ContentConfigurationQuestions;
+/**
+ */
+declare class ContentConfigurationQuestions {
+    /**
+     */
+    constructor(configuration: Object);
+    _configuration: Object;
+    /**
+     */
+    hasConfig(): boolean;
+    /**
+     */
+    get question(): ContentConfigurationElements;
+    /**
+     */
+    get options(): ContentConfigurationElements;
+    /**
+     */
+    get answers(): ContentConfigurationElements;
+}
+import ContentConfigurationElements from "./ContentConfigurationElements";

package/types/models/contentconfiguration/ContentConfigurationResults.d.ts

@@ -0,0 +1,39 @@
+export default ContentConfigurationResults;
+/**
+ */
+declare class ContentConfigurationResults {
+    /**
+     */
+    constructor(configuration: Object);
+    _configuration: Object;
+    _layouthint: LayoutHintCollection;
+    /**
+     */
+    get label(): string;
+    /**
+     */
+    get description(): string;
+    /**
+     */
+    get attributes(): string[];
+    /**
+     */
+    getFormConfigElement(elementKey: string): ContentConfigurationElements;
+    /**
+     */
+    get calculatedResultElements(): ContentConfigurationElements;
+    /**
+     */
+    get positiveResultElements(): ContentConfigurationElements;
+    /**
+     */
+    get negativeResultElements(): ContentConfigurationElements;
+    /**
+     */
+    get resultElements(): ContentConfigurationElements;
+    /**
+     */
+    get layouthint(): LayoutHintCollection;
+}
+import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import ContentConfigurationElements from "./ContentConfigurationElements";

package/types/models/detail/DetailModel.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Base class for details<br/>
+ * For instance the details of case 1<br/>
+ * For instance the details of record 12<br/>
+ */
+export default class DetailModel extends ResourceModel {
+    _attributeCollection: AttributeCollection;
+    _metadataCollection: AttributeCollection;
+    _actionCollection: ActionCollection;
+    /**
+     * Getting the unique identifier of the details
+     */
+    get id(): string;
+    /**
+     * Attribute collection
+     */
+    createAttributeCollection(): void;
+    /**
+     */
+    set attributeCollection(arg: AttributeCollection);
+    /**
+     */
+    get attributeCollection(): AttributeCollection;
+    /**
+     * Retrieve list of visible attributes
+     */
+    get attributes(): AttributeType[];
+    /**
+     * Retrieve an attribute by it's key
+     */
+    getAttributeByKey(key: string): AttributeType | null;
+    /**
+     * Metadata collection
+     */
+    createMetadataCollection(): void;
+    /**
+     */
+    set metadataCollection(arg: AttributeCollection);
+    /**
+     */
+    get metadataCollection(): AttributeCollection;
+    /**
+     * Action collection
+     */
+    createActionCollection(): void;
+    /**
+     */
+    set actionCollection(arg: ActionCollection);
+    /**
+     */
+    get actionCollection(): ActionCollection;
+    /**
+     * Determines if this is a case
+     */
+    get isCase(): boolean;
+    /**
+     * Getting the attribute that has as layout hint 'title'
+     */
+    get titleAttribute(): AttributeType;
+    /**
+     * Update current detail with a new detail model and return a cloned version of the model
+     */
+    update(model: ModularUIModel): DetailModel;
+    /**
+     */
+    equals(model: DetailModel): boolean;
+}
+import ResourceModel from "../base/ResourceModel";
+import AttributeCollection from "../attributes/AttributeCollection";
+import ActionCollection from "../actions/ActionCollection";
+import { AttributeType } from "../types";
+import { ModularUIModel } from "../types";

package/types/models/error/ErrorCollection.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Form Objects
+ */
+export default class ErrorCollection extends BaseCollection<ErrorModel> {
+    /**
+     * constructor
+     */
+    constructor(type: string, errorCollection?: ErrorCollection);
+    _type: string;
+    collection: any[];
+    /**
+     */
+    get serverErrors(): ErrorModel[];
+    /**
+     */
+    findById(id: string): number;
+    /**
+     * Add an error to the collection
+     */
+    addError(id: string, defaultMessage?: string, parameters?: MessageParameters, layouthint?: LayoutHintCollection): void;
+    /**
+     */
+    removeError(id: string): void;
+    /**
+     * Add a server error to the collection
+     */
+    addServerError(id: string, defaultMessage?: string, parameters?: MessageParameters, layouthint?: LayoutHintCollection): void;
+    /**
+     */
+    removeServerError(id: string): void;
+    /**
+     */
+    removeServerErrors(): void;
+    /**
+     */
+    addErrors(errors: Array<ErrorModel>): void;
+    /**
+     * Add constraints to error collection
+     */
+    addConstraints(constraints: Array<IConstraintModel>): void;
+    /**
+     * Indicates if a mandatory constraint is available and if it is in error.
+     * Rationale: When a mandatory constraint is in error other constraint probably don't mather because there is no value to check
+     */
+    hasMandatoryError(): boolean;
+}
+import ErrorModel from "./ErrorModel";
+import BaseCollection from "../base/BaseCollection";
+import { MessageParameters } from "../../i18n/types";
+import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import { IConstraintModel } from "../types";

package/types/models/error/ErrorModel.d.ts

@@ -0,0 +1,36 @@
+export default ErrorModel;
+/**
+ * Wrapper around an error message / object
+ */
+declare class ErrorModel {
+    /**
+     * Contruct
+     */
+    constructor(id: string, defaultMessage: string | null, parameters: MessageParameters | null, isClientConstraint?: boolean, layouthint?: LayoutHintCollection);
+    _id: string;
+    _defaultMessage: string | null;
+    _parameters: MessageParameters | null;
+    _isClientConstraint: boolean;
+    _layouthint: LayoutHintCollection;
+    /**
+     * Get id of error
+     */
+    get id(): string;
+    /**
+     */
+    get defaultMessage(): string;
+    /**
+     */
+    get parameters(): MessageParameters;
+    /**
+     */
+    get isClientConstraint(): boolean;
+    /**
+     */
+    get layouthint(): LayoutHintCollection;
+    /**
+     */
+    get isMandatoryConstraint(): boolean;
+}
+import { MessageParameters } from "../../i18n/types";
+import LayoutHintCollection from "../layouthint/LayoutHintCollection";

package/types/models/error/ErrorResponse.d.ts

@@ -0,0 +1,148 @@
+type TitleObject = {};
+type RedirectTextObject = {};
+type RedirectObject = {};
+/**
+ * Error response model
+ */
+export default class ErrorResponse {
+    /**
+     * Construct ErrorResponse
+     */
+    constructor(data: Object, connectKey?: string);
+    _error: Object;
+    _connectKey: string | null;
+    /**
+     */
+    set connectKey(arg: string);
+    /**
+     */
+    get connectKey(): string;
+    /**
+     * Return error information
+     */
+    get error(): Object;
+    /**
+     * Get request status code
+     */
+    get status(): number;
+    /**
+     * Return error type information
+     */
+    get id(): string;
+    /**
+     */
+    get message(): string;
+    /**
+     * Return response error message
+     */
+    get responseMessage(): string;
+    /**
+     *  Return response error title
+     */
+    get title(): TitleObject;
+    /**
+     * Return response error title message
+     */
+    get titleMessage(): string;
+    /**
+     * Return response error title Id
+     */
+    get titleId(): string;
+    /**
+     *  Return response error title properties
+     */
+    get titleProperties(): Object;
+    /**
+     *  Return response error redirect
+     */
+    get redirect(): RedirectObject;
+    /**
+     *  Return response error redirect text
+     */
+    get redirectText(): RedirectTextObject;
+    /**
+     * Return response error redirect text id
+     */
+    get redirectTextID(): string;
+    /**
+     *  Return response error redirect text properties
+     */
+    get redirectTextProperties(): Object;
+    /**
+     * Return response error redirect text message
+     */
+    get redirectMessage(): string;
+    /**
+     *  Return response error redirect href
+     */
+    get redirectHref(): Href;
+    /**
+     * Return error response layouthint
+     */
+    get layouthint(): LayoutHintCollection;
+    /**
+     */
+    get response(): Object;
+    /**
+     */
+    get properties(): Object;
+    /**
+     * Return error parameters
+     */
+    get parameters(): MessageParameters;
+    /**
+     */
+    get isResourceNotFound(): boolean;
+    /**
+     */
+    get isResourceNotFoundAfterReload(): boolean;
+    /**
+     * Check if the error message is an authorization error
+     */
+    get isUnauthorized(): boolean;
+    /**
+     */
+    get isChangePassword(): boolean;
+    /**
+     */
+    get isConcurrentUser(): boolean;
+    /**
+     */
+    get isConcurrentError(): boolean;
+    /**
+     */
+    get isBlocked(): boolean;
+    /**
+     */
+    get isInvalidCredentials(): boolean;
+    /**
+     */
+    get isInvalidUsername(): boolean;
+    /**
+     */
+    get isTimeoutError(): boolean;
+    /**
+     * A RemoteServiceException occurs when an exception occurs connecting to an external system,
+     * for example when using the service list panels
+     */
+    get isRemoteServiceException(): boolean;
+    /**
+     * Get response url
+     */
+    get changePasswordHref(): Href;
+    /**
+     * When no action information is present in the unauthorized response, for now we assume it is Basic Authentication
+     */
+    get isBasicAuthentication(): boolean;
+    /**
+     * Retrieve a failed login attempt
+     */
+    get loginFailed(): boolean;
+    /**
+     */
+    get shouldThrowOnServer(): boolean;
+}
+import Href from "../href/Href";
+import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import { MessageParameters } from "../../i18n/types";
+export {};