@beinformed/ui 1.59.21 → 1.59.23

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [1.59.23](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.59.22...v1.59.23) (2025-02-18)
+
+
+### Bug Fixes
+
+* **proxies:** remove proxy folders, add exports entries ([02cdf6a](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/commit/02cdf6a5f5aacd18039f51402c08f03aade07e05))
+
+## [1.59.22](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.59.21...v1.59.22) (2025-02-18)
+
+
+### Bug Fixes
+
+* **types:** update build files to put d.ts files in esm and lib folders ([6bcf76f](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/commit/6bcf76f916cefe36fd50a05dff0add17bde13df9))
+
 ## [1.59.21](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.59.21-beta.5...v1.59.21) (2025-02-18)
 
 

package/esm/hooks/useI18n.d.ts

@@ -0,0 +1,13 @@
+/**
+ */
+export function useTranslate(): ((...any: any) => any);
+/**
+ */
+export function useMessage(id: string, defaultMessage?: string, placeholders?: Object | null): any;
+/**
+ */
+export function useLocale(): string;
+/**
+ * Retrieve all available locale codes
+ */
+export function useLocaleCodes(): Array<string>;

package/esm/hooks/useModelCatalog.d.ts

@@ -0,0 +1,32 @@
+type SearchFilter = {
+    index?: string | undefined;
+    label?: string | undefined;
+    type?: string | string[] | undefined;
+    modelCategory?: string | string[] | undefined;
+    entryDate?: string | undefined;
+};
+export function useModelCatalog(options?: UseModularUIBasicOptions<ModelCatalogModel>): ModelCatalogModel | null;
+export function useConceptIndex(href: string | Href, key?: string, options?: UseModularUIBasicOptions<ConceptIndexModel>): ConceptIndexModel | null;
+export function useConceptDetail(concept: string | Href, key?: string, options?: UseModularUIBasicOptions<ConceptDetailModel | BusinessScenarioModel>): (ConceptDetailModel | (BusinessScenarioModel | null)) | null;
+export function useContentIndex(href: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentIndexModel>): ContentIndexModel | null;
+export function useContentTOC(content: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentTOCModel>): ContentTOCModel | null;
+export function useContent(contentSection: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentModel>): ContentModel | null;
+export function useContentType(contentType: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentTypeModel>): ContentTypeModel | null;
+export function useConceptSearch(filters: SearchFilter, key?: string, options?: UseModularUIBasicOptions<ConceptIndexModel>): ConceptIndexModel | null;
+export function useContentSearch(filters: SearchFilter, key?: string, options?: UseModularUIBasicOptions<ContentIndexModel>): ContentIndexModel | null;
+export function useEntryDate(): ({
+    entryDate: ISO_DATE;
+    setEntryDate: (entryDate: ISO_DATE) => UpdateEntryDateAction;
+});
+import { UseModularUIBasicOptions } from "./useModularUIBasic";
+import ModelCatalogModel from "../models/modelcatalog/ModelCatalogModel";
+import Href from "../models/href/Href";
+import ConceptIndexModel from "../models/concepts/ConceptIndexModel";
+import ConceptDetailModel from "../models/concepts/ConceptDetailModel";
+import { default as BusinessScenarioModel } from "../models/concepts/BusinessScenarioModel";
+import ContentIndexModel from "../models/content/ContentIndexModel";
+import ContentTOCModel from "../models/content/ContentTOCModel";
+import ContentModel from "../models/content/ContentModel";
+import { ContentTypeModel } from "../models";
+import { UpdateEntryDateAction } from "../redux";
+export {};

package/esm/i18n/Locales.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Array of available locales
+ * Order of locales is the preferred order of locales.
+ * When user has an accept language header that does not correspond to the locales array,
+ * the first one is used as the preferred language
+ */
+export const availableLocales: Array<LocaleConfiguration>;
+export function createLocalesWithConfiguredErrors(configuredErrors: ErrorMessageObject): Array<Object>;
+export default Locales;
+import { LocaleConfiguration } from "./types";
+type ErrorMessageObject = {
+    [languageCode: string]: {
+        [messageID: string]: string;
+    };
+};
+/**
+ * Locales, collection of Locale
+ */
+declare class Locales extends BaseCollection<Locale> {
+    /**
+     * rehydrate
+     */
+    static rehydrate(hydatedLocales: HydratedLocales): Locales;
+    constructor(locales?: Array<LocaleConfiguration>);
+    /**
+     * Check if locale with localeCode exists
+     */
+    hasLocale(localeCode: string): boolean;
+    /**
+     * Retrieve locales by localeCode from Locales collection
+     */
+    getLocale(localeCode: string): Locale;
+    /**
+     * Retrieve all available locale codes
+     */
+    get availableLocaleCodes(): Array<string>;
+    /**
+     * Retrieve preferred locale based on the accept header of a browser
+     */
+    getPreferredLocale(acceptLanguageHeader: string | null): void | string;
+    /**
+     * Add or change messages and errors for the given locale.<br>
+     * It is not possible to remove messages.
+     */
+    update(locale: string, messages?: Object, errors?: Object): void;
+}
+import Locale from "./Locale";
+import BaseCollection from "../models/base/BaseCollection";
+type HydratedLocales = {
+    _collection: {
+        _code: string;
+        _messages: {
+            [x: number]: string;
+        };
+        _errors: {
+            [x: number]: string;
+        };
+    }[];
+};

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

@@ -0,0 +1,82 @@
+/**
+ * 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, origin?: string, contextPath?: string): ActionModel;
+    _fieldCollection: AttributeCollection;
+    _href: Href;
+    _icon: string;
+    /**
+     */
+    get isDisabled(): boolean;
+    /**
+     */
+    set selfhref(href: Href);
+    /**
+     * retrieve href of action
+     */
+    get selfhref(): Href;
+    /**
+     * retrieve request method
+     */
+    get method(): $Keys<typeof HTTP_METHODS>;
+    /**
+     * 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(): Array<AttributeType>;
+    /**
+     */
+    set fieldCollection(fieldCollection: 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 | null;
+    /**
+     */
+    set icon(icon: string);
+    /**
+     */
+    get icon(): string;
+}
+import BaseModel from "../base/BaseModel";
+import AttributeCollection from "../attributes/AttributeCollection";
+import Href from "../href/Href";
+import { HTTP_METHODS } from "../../constants";
+import { AttributeType } from "../types";
+import ProcessStatusSettingsModel from "../process/ProcessStatusSettingsModel";

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

@@ -0,0 +1,48 @@
+/**
+ * The Application model
+ */
+export default class ApplicationModel extends ResourceModel {
+    _userServices: UserServicesModel | null;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
+    /**
+     * Set the userservices for this application
+     */
+    set userServices(model: ModularUIModel | null);
+    /**
+     * returns the userservices configured for this application
+     */
+    get userServices(): UserServicesModel | null;
+    /**
+     * Getting the authentication types of the application
+     */
+    get authenticationTypes(): Array<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 | null;
+    /**
+     */
+    get userMustChangePassword(): boolean;
+}
+import ResourceModel from "../base/ResourceModel";
+import UserServicesModel from "../user/UserServicesModel";
+import { ModularUIModel } from "../types";
+import { AuthenticationType } from "../types";
+import LinkCollection from "../links/LinkCollection";
+import LinkModel from "../links/LinkModel";
+import Href from "../href/Href";

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

@@ -0,0 +1,102 @@
+export default AttributeCollection;
+/**
+ * Collection of attributes
+ */
+declare class AttributeCollection extends ResourceCollection<AttributeType, any> {
+    constructor(data?: Object | Array<Object>, contributions?: Array<Object>, modelOptions?: AttributeCollectionOptions);
+    /**
+     * Replace attributes with a new array of attributes
+     */
+    set attributes(attributes: Array<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(): Array<AttributeType>;
+    /**
+     */
+    processLayoutHintRules(): void;
+    /**
+     * Retrieve only visible attributes from the collection
+     */
+    get visible(): Array<AttributeType>;
+    /**
+     */
+    get questions(): Array<AttributeType>;
+    /**
+     */
+    get results(): Array<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(): {
+        [string]: any;
+    } | null;
+    /**
+     */
+    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";
+type AttributeCollectionOptions = {
+    ModelOptions: any;
+    isReadonly: boolean;
+};

package/esm/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 | null;
+    /**
+     */
+    getContentElements<T>(elementName: string): Array<T>;
+    /**
+     */
+    getContentElementCollections<T>(elementName: string, collectionName: string): Array<T>;
+    /**
+     */
+    getContentElementCollectionByLabels<T, U>(elementName: string, collectionName: string, labels: Array<string>): Array<U>;
+    /**
+     */
+    get properties(): Array<PropertyData>;
+    /**
+     * Get concept properties by property element label
+     */
+    getConceptPropertiesByLabels(labels: Array<string>): Array<PropertyData>;
+    /**
+     */
+    get textfragments(): Array<TextFragmentData>;
+    /**
+     * Get concept text fragments by text fragment element label
+     */
+    getTextFragmentsByLabels(labels: Array<string>): Array<TextFragmentData>;
+    /**
+     */
+    get sections(): Array<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/esm/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(): Array<AttributeDataHelper>;
+    /**
+     */
+    get content(): Object;
+    /**
+     */
+    getData(): Object;
+}