@beinformed/ui 1.59.21 → 1.59.23

package/lib/exceptions/UnauthorizedException.d.ts

@@ -0,0 +1,11 @@
+export default UnauthorizedException;
+/**
+ * UnauthorizedException
+ */
+declare class UnauthorizedException extends Error {
+    constructor(url: string, method: string, errorResponse: ModularUIErrorResponse | null);
+    status: number;
+    id: string;
+    response: ModularUIErrorResponse | null;
+}
+import { ModularUIErrorResponse } from "./FetchException";

package/lib/exceptions/UnsupportedOperationException.d.ts

@@ -0,0 +1,7 @@
+export default UnsupportedOperationException;
+/**
+ * UnsupportedOperationException
+ */
+declare class UnsupportedOperationException extends Error {
+    constructor(message: string);
+}

package/lib/exceptions/index.d.ts

@@ -0,0 +1,15 @@
+export { default as FetchException } from "./FetchException";
+export { default as MissingPropertyException } from "./MissingPropertyException";
+export { default as NotAllowedUriException } from "./NotAllowedUriException";
+export { default as IllegalArgumentException } from "./IllegalArgumentException";
+export { default as IllegalReturnException } from "./IllegalReturnException";
+export { default as IllegalStateException } from "./IllegalStateException";
+export { default as JsonParseException } from "./JsonParseException";
+export { default as ConfigurationException } from "./ConfigurationException";
+export { default as UnauthorizedException } from "./UnauthorizedException";
+export { default as UnsupportedOperationException } from "./UnsupportedOperationException";
+export { default as TimeoutException } from "./TimeoutException";
+export { default as NotFoundException } from "./NotFoundException";
+export { default as NetworkException } from "./NetworkException";
+export { default as ServerRequestException } from "./ServerRequestException";
+export { default as ThemePropertyException } from "./ThemePropertyException";

package/lib/hooks/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./useAuthentication";
+export * from "./useContent";
+export * from "./useForm";
+export * from "./useI18n";
+export * from "./useModal";
+export * from "./useModelCatalog";
+export * from "./useModels";
+export * from "./useModularUI";
+export * from "./useModularUIBasic";
+export * from "./useModularUIModel";
+export * from "./useModularUIRequest";
+export * from "./useNotification";
+export * from "./usePreference";
+export * from "./useProgressIndicator";
+export * from "./useRouter";
+export * from "./useAllFormsOnModel";

package/lib/hooks/useAllFormsOnModel.d.ts

@@ -0,0 +1,7 @@
+export function useRetrieveFormsOnModel(model: ListModel | DetailModel | TabModel): null | {
+    [actionName: string]: FormModel;
+};
+import ListModel from "../models/list/ListModel";
+import DetailModel from "../models/detail/DetailModel";
+import TabModel from "../models/tab/TabModel";
+import FormModel from "../models/form/FormModel";

package/lib/hooks/useAuthentication.d.ts

@@ -0,0 +1,16 @@
+export function useLogin(): LoginHook;
+export function useLogout(): LogoutHook;
+type LoginHook = {
+    isAuthenticated: boolean;
+    authenticationTypes: AuthenticationType[];
+    errorMessage: string | null;
+    resetErrors: () => ResetAuthErrorsAction;
+    login: (username: string, password: string) => void;
+    redirectLogin: (authenticationType: AuthenticationType) => void;
+};
+type LogoutHook = {
+    isAuthenticated: boolean;
+    authenticationTypes: AuthenticationType[];
+    logout: () => void;
+};
+export {};

package/lib/hooks/useContent.d.ts

@@ -0,0 +1,3 @@
+export function useContentFromSourceReferences(sourceReferences: SourceReferenceCollection, renderChildSections: boolean): Array<ContentModel>;
+import SourceReferenceCollection from "../models/concepts/SourceReferenceCollection";
+import ContentModel from "../models/content/ContentModel";

package/lib/hooks/useDeepCompareEffect.d.ts

@@ -0,0 +1,6 @@
+/**
+ */
+export function useDeepCompareEffect(callback: Callback, dependencies: DependencyList): void;
+export default useDeepCompareEffect;
+type Callback = () => void | (() => void);
+type DependencyList = mixed[];

package/lib/hooks/useForm.d.ts

@@ -0,0 +1,21 @@
+export function useForm(href: string | Href, data?: Object): FormModel | null;
+export function useFormNavigation(): FormNavigationHook;
+export function useAttributeUpdate(form: FormModel, object: FormObjectModel): AttributeUpdateHook;
+export function useAttributeSet(form: FormModel): AttributeSetHook;
+import Href from "../models/href/Href";
+import FormModel from "../models/form/FormModel";
+type FormNavigationHook = {
+    previous: (form: FormModel) => UpdateFormAction;
+    cancel: (form: FormModel) => void;
+    submit: (form: FormModel) => void;
+    showFormNotification: (form: FormModel) => void;
+    remove: (form: FormModel) => RemoveModelByKeyAction;
+};
+import { FormObjectModel } from "../models";
+type AttributeUpdateHook = (attribute: AttributeType, value: string, options: UpdateFormOptions) => void;
+type AttributeSetHook = {
+    save: () => UpdateFormAction;
+    cancel: (object: FormObjectModel) => UpdateFormAction;
+    remove: (object: FormObjectModel) => UpdateFormAction;
+};
+export {};

package/lib/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/lib/hooks/useModal.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Manage modals
+ */
+export const useModal: ModalHook;
+type ModalHook = (modalId: string) => {
+    key: string | null;
+    size: string | null;
+    visible: boolean;
+    show: () => void;
+    close: () => void;
+};
+export {};

package/lib/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/lib/hooks/useModels.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Hook that contains the reload property that can be used to reload a model
+ */
+export const useModels: UseModels;
+type UseModels = () => {
+    reload: (model: ModularUIModel, options?: any) => void;
+    reloadWithFilter: (callbackFn: ReloadCallback, options?: any) => void;
+};
+type ReloadCallback = (model: ModularUIModel) => boolean;
+export {};

package/lib/hooks/useModularUI.d.ts

@@ -0,0 +1,3 @@
+export function useModularUI(modelKey: string, url: string | Href, options?: RequestModularUIOptions): any;
+import Href from "../models/href/Href";
+import { RequestModularUIOptions } from "../utils";

package/lib/hooks/useModularUIBasic.d.ts

@@ -0,0 +1,9 @@
+type UseModularUIBasicOptions<T, ModularUIModel> = {
+    expectedModels?: string[] | undefined;
+    targetModel?: any;
+    forceTargetModel?: boolean | undefined;
+    origin?: string | undefined;
+    contextPath?: string | undefined;
+    cache?: boolean | undefined;
+};
+export {};

package/lib/hooks/useModularUIModel.d.ts

@@ -0,0 +1,27 @@
+export function useApplication(options?: HookOptions): ApplicationModel | null;
+export function useTab(href: string | Href, options?: HookOptions): TabModel | null;
+export function useCaseView(href: string | Href, options?: HookOptions): CaseViewModel | null;
+export function usePanel(href: string | Href, options?: HookOptions): ListModel | GroupingPanelModel | DetailModel | null;
+export function useList(href: string | Href, options?: HookOptions): ListModel | null;
+export function useListOrDetail(href: string | Href, options?: HookOptions): ListModel | DetailModel | null;
+export function useListDetail(href: string | Href, options?: HookOptions): ListDetailModel | null;
+export function useGroupingPanel(href: string | Href, options?: HookOptions): GroupingPanelModel | null;
+export function useDetailPanel(href: string | Href, options?: HookOptions): DetailModel | null;
+export function useQuicksearch(href: string | Href, options?: HookOptions): CaseSearchModel | null;
+export function useSearch(href: string | Href, options?: HookOptions): CaseSearchModel | null;
+export function useUserProfile(href: string | Href, options?: HookOptions): UserProfileModel | null;
+type HookOptions = {
+    origin?: string | undefined;
+    contextPath?: string | undefined;
+};
+import ApplicationModel from "../models/application/ApplicationModel";
+import Href from "../models/href/Href";
+import TabModel from "../models/tab/TabModel";
+import CaseViewModel from "../models/caseview/CaseViewModel";
+import ListModel from "../models/list/ListModel";
+import GroupingPanelModel from "../models/panels/GroupingPanelModel";
+import DetailModel from "../models/detail/DetailModel";
+import ListDetailModel from "../models/list/ListDetailModel";
+import CaseSearchModel from "../models/search/CaseSearchModel";
+import UserProfileModel from "../models/user/UserProfileModel";
+export {};

package/lib/hooks/useModularUIRequest.d.ts

@@ -0,0 +1,4 @@
+export function useModularUIRequest(): ((href: Href, options?: $Shape<RequestModularUIOptions>) => ModularUIRequest);
+import Href from "../models/href/Href";
+import { RequestModularUIOptions } from "../utils";
+import ModularUIRequest from "../modularui/ModularUIRequest";

package/lib/hooks/useNotification.d.ts

@@ -0,0 +1,8 @@
+export function useNotification(): NotificationHook;
+export function useErrorNotification(): ErrorNotificationHook;
+type NotificationHook = {
+    NotificationState: any;
+    dismiss: () => DismissNotificationAction;
+};
+type ErrorNotificationHook = (message: MessageObject, error?: ErrorResponse | null | undefined) => ShowNotificationAction;
+export {};

package/lib/hooks/usePreference.d.ts

@@ -0,0 +1,2 @@
+export function usePreference(preferenceNames: string | Array<string>): PreferencesState;
+import { PreferencesState } from "../redux/types";

package/lib/hooks/useProgressIndicator.d.ts

@@ -0,0 +1,9 @@
+export function useProgressIndicator(): ProgressIndicatorHook;
+type ProgressIndicatorHook = {
+    ProgressIndicatorState: any;
+    start: () => void;
+    finish: () => void;
+    reset: () => void;
+    update: (percentComplete: number) => void;
+};
+export {};

package/lib/hooks/useRouter.d.ts

@@ -0,0 +1,23 @@
+/**
+ */
+export const useLocation: UseLocationHook;
+/**
+ */
+export const useLocationKey: UseLocationKeyHook;
+/**
+ */
+export const useQuerystring: UseQuerystringHook;
+/**
+ */
+export const usePathname: UsePathnameHook;
+/**
+ */
+export const useNavigation: UseNavigationHook;
+type UseLocationHook = () => Location;
+type UseLocationKeyHook = () => string;
+type UseQuerystringHook = () => string;
+type UsePathnameHook = () => string;
+type UseNavigationHook = () => {
+    push: (location: any, state?: {} | undefined, ...: any[]) => any;
+};
+export {};

package/lib/i18n/Locale.d.ts

@@ -0,0 +1,53 @@
+export default Locale;
+/**
+ * Create a locale
+ */
+declare class Locale {
+    constructor(locale: LocaleConfiguration);
+    _code: string;
+    _messages: {
+        [string]: string;
+    };
+    _errors: {
+        [string]: string;
+    };
+    _nativeName: string | null;
+    /**
+     * Retrieve locale code
+     */
+    get code(): string;
+    /**
+     * Retrieve nativeName
+     */
+    get nativeName(): string;
+    /**
+     * Exported messages from Be Informed have placeholders in the syntax ${placeholder_name}
+     * where the ICU messageformat module uses {placeholder_name}.
+     * This method converts the ${} to {}
+     */
+    fixPlaceHolders(message: string | null): null | string;
+    /**
+     * Exported messages from Be Informed have placeholders in the syntax ${placeholder_name}
+     * where the ICU messageformat module uses {placeholder_name}.
+     * This method converts the ${} to {}
+     */
+    fixPlaceHoldersInObject(messages?: Object): Object;
+    /**
+     * Retrieve message by id
+     */
+    getBaseMessage(id: string, defaultMessage?: string): string;
+    /**
+     * Format message using formatMessage library
+     */
+    formatMessage(message: string, parameters?: MessageParameters): string;
+    /**
+     * Retrieve a messages with replaced parameters
+     */
+    getMessage(id: string, defaultMessage?: string, parameters?: MessageParameters): string;
+    /**
+     * Add or change messages for this locale. It is not possible to remove messages.
+     */
+    update(messages?: Object, errors?: Object): void;
+}
+import { MessageParameters } from "./types";
+import { LocaleConfiguration } from "./types";

package/lib/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/lib/i18n/Message.d.ts

@@ -0,0 +1,6 @@
+export default Message;
+/**
+ * Message React component
+ */
+declare const Message: React$AbstractComponent<MessageProps, mixed>;
+type MessageProps = {};

package/lib/i18n/index.d.ts

@@ -0,0 +1,5 @@
+export { default as Message } from "./Message";
+export { default as withMessage } from "./withMessage";
+export type * from "./types";
+export { default as Locales, availableLocales, createLocalesWithConfiguredErrors } from "./Locales";
+export { useMessage, useTranslate } from "../hooks/useI18n";

package/lib/i18n/languages.d.ts

@@ -0,0 +1,215 @@
+export default languages;
+declare namespace languages {
+    namespace attribute {
+        let name: number;
+        let nativeName: number;
+    }
+    namespace rtl {
+        let ar: number;
+        let dv: number;
+        let fa: number;
+        let ha: number;
+        let he: number;
+        let ks: number;
+        let ku: number;
+        let ps: number;
+        let ur: number;
+        let yi: number;
+    }
+    namespace lang {
+        export let aa: string[];
+        export let ab: string[];
+        export let af: string[];
+        export let ak: string[];
+        export let am: string[];
+        export let an: string[];
+        let ar_1: string[];
+        export { ar_1 as ar };
+        export let as: string[];
+        export let av: string[];
+        export let ay: string[];
+        export let az: string[];
+        export let ba: string[];
+        export let be: string[];
+        export let bg: string[];
+        export let bh: string[];
+        export let bi: string[];
+        export let bm: string[];
+        export let bn: string[];
+        export let bo: string[];
+        export let br: string[];
+        export let bs: string[];
+        export let ca: string[];
+        export let ce: string[];
+        export let ch: string[];
+        export let co: string[];
+        export let cr: string[];
+        export let cs: string[];
+        export let cu: string[];
+        export let cv: string[];
+        export let cy: string[];
+        export let da: string[];
+        export let de: string[];
+        let dv_1: string[];
+        export { dv_1 as dv };
+        export let dz: string[];
+        export let ee: string[];
+        export let el: string[];
+        export let en: string[];
+        export let eo: string[];
+        export let es: string[];
+        export let et: string[];
+        export let eu: string[];
+        let fa_1: string[];
+        export { fa_1 as fa };
+        export let ff: string[];
+        export let fi: string[];
+        export let fj: string[];
+        export let fo: string[];
+        export let fr: string[];
+        export let fy: string[];
+        export let ga: string[];
+        export let gd: string[];
+        export let gl: string[];
+        export let gn: string[];
+        export let gu: string[];
+        export let gv: string[];
+        let ha_1: string[];
+        export { ha_1 as ha };
+        let he_1: string[];
+        export { he_1 as he };
+        export let hi: string[];
+        export let ho: string[];
+        export let hr: string[];
+        export let ht: string[];
+        export let hu: string[];
+        export let hy: string[];
+        export let hz: string[];
+        export let ia: string[];
+        export let id: string[];
+        export let ie: string[];
+        export let ig: string[];
+        export let ii: string[];
+        export let ik: string[];
+        export let io: string[];
+        export let is: string[];
+        export let it: string[];
+        export let iu: string[];
+        export let ja: string[];
+        export let jv: string[];
+        export let ka: string[];
+        export let kg: string[];
+        export let ki: string[];
+        export let kj: string[];
+        export let kk: string[];
+        export let kl: string[];
+        export let km: string[];
+        export let kn: string[];
+        export let ko: string[];
+        export let kr: string[];
+        let ks_1: string[];
+        export { ks_1 as ks };
+        let ku_1: string[];
+        export { ku_1 as ku };
+        export let kv: string[];
+        export let kw: string[];
+        export let ky: string[];
+        export let la: string[];
+        export let lb: string[];
+        export let lg: string[];
+        export let li: string[];
+        export let ln: string[];
+        export let lo: string[];
+        export let lt: string[];
+        export let lv: string[];
+        export let mg: string[];
+        export let mh: string[];
+        export let mi: string[];
+        export let mk: string[];
+        export let ml: string[];
+        export let mn: string[];
+        export let mo: string[];
+        export let mr: string[];
+        export let ms: string[];
+        export let mt: string[];
+        export let my: string[];
+        export let na: string[];
+        export let nd: string[];
+        export let ne: string[];
+        export let ng: string[];
+        export let nl: string[];
+        export let nn: string[];
+        export let no: string[];
+        export let nr: string[];
+        export let nv: string[];
+        export let ny: string[];
+        export let oc: string[];
+        export let oj: string[];
+        export let om: string[];
+        export let or: string[];
+        export let os: string[];
+        export let pa: string[];
+        export let pi: string[];
+        export let pl: string[];
+        let ps_1: string[];
+        export { ps_1 as ps };
+        export let pt: string[];
+        export let qu: string[];
+        export let rm: string[];
+        export let rn: string[];
+        export let ro: string[];
+        export let ru: string[];
+        export let rw: string[];
+        export let sa: string[];
+        export let sc: string[];
+        export let sd: string[];
+        export let se: string[];
+        export let sg: string[];
+        export let sh: string[];
+        export let si: string[];
+        export let sk: string[];
+        export let sl: string[];
+        export let sm: string[];
+        export let sn: string[];
+        export let so: string[];
+        export let sq: string[];
+        export let sr: string[];
+        export let ss: string[];
+        export let st: string[];
+        export let su: string[];
+        export let sv: string[];
+        export let sw: string[];
+        export let ta: string[];
+        export let te: string[];
+        export let tg: string[];
+        export let th: string[];
+        export let ti: string[];
+        export let tk: string[];
+        export let tl: string[];
+        export let tn: string[];
+        export let to: string[];
+        export let tr: string[];
+        export let ts: string[];
+        export let tt: string[];
+        export let tw: string[];
+        export let ty: string[];
+        export let ug: string[];
+        export let uk: string[];
+        let ur_1: string[];
+        export { ur_1 as ur };
+        export let uz: string[];
+        export let ve: string[];
+        export let vi: string[];
+        export let vo: string[];
+        export let wa: string[];
+        export let wo: string[];
+        export let xh: string[];
+        let yi_1: string[];
+        export { yi_1 as yi };
+        export let yo: string[];
+        export let za: string[];
+        export let zh: string[];
+        export let zu: string[];
+        export let pap: string[];
+    }
+}